UI:
[blender-staging.git] / source / blender / makesdna / DNA_userdef_types.h
1 /**
2  * blenkernel/DNA_userdef_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
32 #ifndef DNA_USERDEF_TYPES_H
33 #define DNA_USERDEF_TYPES_H
34
35 #include "DNA_listBase.h"
36 #include "DNA_texture_types.h"
37
38 /* themes; defines in BIF_resource.h */
39 struct ColorBand;
40
41 /* ************************ style definitions ******************** */
42
43 #define MAX_STYLE_NAME  64
44 #define MAX_FONT_NAME   256
45
46 /* default uifont_id offered by Blender */
47 #define UIFONT_DEFAULT  0
48 #define UIFONT_BITMAP   1
49 /* free slots */
50 #define UIFONT_CUSTOM1  2
51 #define UIFONT_CUSTOM2  3
52
53 /* default fonts to load/initalize */
54 /* first font is the default (index 0), others optional */
55 typedef struct uiFont {
56         struct uiFont *next, *prev;
57         char filename[256];
58         short blf_id;           /* from blfont lib */
59         short uifont_id;        /* own id */
60         short r_to_l;           /* fonts that read from left to right */
61         short pad;
62         
63 } uiFont;
64
65 /* this state defines appearance of text */
66 typedef struct uiFontStyle {
67         short uifont_id;                /* saved in file, 0 is default */
68         short points;                   /* actual size depends on 'global' dpi */
69         short italic, bold;             /* style hint */
70         short shadow;                   /* value is amount of pixels blur */
71         short shadx, shady;             /* shadow offset in pixels */
72         short align;                    /* text align hint */
73         float shadowalpha;              /* total alpha */
74         float shadowcolor;              /* 1 value, typically white or black anyway */
75         
76 } uiFontStyle;
77
78 /* uiFontStyle->align */
79 #define UI_STYLE_TEXT_LEFT              0
80 #define UI_STYLE_TEXT_CENTER    1
81 #define UI_STYLE_TEXT_RIGHT             2
82
83
84 /* this is fed to the layout engine and widget code */
85 typedef struct uiStyle {
86         struct uiStyle *next, *prev;
87         
88         char name[64];                  /* MAX_STYLE_NAME */
89         
90         uiFontStyle paneltitle;
91         uiFontStyle grouplabel;
92         uiFontStyle widgetlabel;
93         uiFontStyle widget;
94         
95         short minlabelchars;    /* in characters */
96         short minwidgetchars;   /* in characters */
97
98         short columnspace;
99         short templatespace;
100         short boxspace;
101         short buttonspacex;
102         short buttonspacey;
103
104         short pad;
105 } uiStyle;
106
107 typedef struct uiWidgetColors {
108         char outline[4];
109         char inner[4];
110         char inner_sel[4];
111         char item[4];
112         char text[4];
113         char text_sel[4];
114         short shaded;
115         short shadetop, shadedown;
116         short pad;
117 } uiWidgetColors;
118
119 typedef struct ThemeUI {
120         
121         /* Interface Elements (buttons, menus, icons) */
122         uiWidgetColors wcol_regular, wcol_tool, wcol_radio, wcol_text, wcol_option;
123         uiWidgetColors wcol_num, wcol_numslider;
124         uiWidgetColors wcol_menu, wcol_pulldown, wcol_menu_back, wcol_menu_item;
125         
126         char iconfile[80];      // FILE_MAXFILE length
127         
128 } ThemeUI;
129
130 /* try to put them all in one, if needed a special struct can be created as well
131  * for example later on, when we introduce wire colors for ob types or so...
132  */
133 typedef struct ThemeSpace {
134         /* main window colors */
135         char back[4];
136         char title[4];
137         char text[4];   
138         char text_hi[4];
139         
140         /* header colors */
141         char header[4];
142         char header_title[4];
143         char header_text[4];    
144         char header_text_hi[4];
145
146         /* button/tool regions */
147         char button[4];
148         char button_title[4];
149         char button_text[4];    
150         char button_text_hi[4];
151         
152         /* listview regions */
153         char list[4];
154         char list_title[4];
155         char list_text[4];      
156         char list_text_hi[4];
157         
158         /* float panel */
159         char panel[4];
160         char panel_title[4];    
161         char panel_text[4];     
162         char panel_text_hi[4];
163         
164         char shade1[4];
165         char shade2[4];
166         
167         char hilite[4];
168         char grid[4]; 
169         
170         char wire[4], select[4];
171         char lamp[4];
172         char active[4], group[4], group_active[4], transform[4];
173         char vertex[4], vertex_select[4];
174         char edge[4], edge_select[4];
175         char edge_seam[4], edge_sharp[4], edge_facesel[4];
176         char face[4], face_select[4];   // solid faces
177         char face_dot[4];                               // selected color
178         char normal[4];
179         char bone_solid[4], bone_pose[4];
180         char strip[4], strip_select[4];
181         char cframe[4];
182         char ds_channel[4], ds_subchannel[4]; // dopesheet
183         
184         char vertex_size, facedot_size;
185         char bpad[2]; 
186
187         char syntaxl[4], syntaxn[4], syntaxb[4]; // syntax for textwindow and nodes
188         char syntaxv[4], syntaxc[4];
189         
190         char movie[4], image[4], scene[4], audio[4];            // for sequence editor
191         char effect[4], plugin[4], transition[4], meta[4];
192         char editmesh_active[4]; 
193
194         char handle_vertex[4];
195         char handle_vertex_select[4];
196         
197         char handle_vertex_size;
198         char hpad[3];
199         
200         char pad[4];
201         
202 } ThemeSpace;
203
204
205 /* set of colors for use as a custom color set for Objects/Bones wire drawing */
206 typedef struct ThemeWireColor {
207         char    solid[4];
208         char    select[4];
209         char    active[4];
210         
211         short   flag;
212         short   pad;
213 } ThemeWireColor; 
214
215 /* flags for ThemeWireColor */
216 #define TH_WIRECOLOR_CONSTCOLS  (1<<0)
217 #define TH_WIRECOLOR_TEXTCOLS   (1<<1)
218
219 /* A theme */
220 typedef struct bTheme {
221         struct bTheme *next, *prev;
222         char name[32];
223         
224         ThemeUI tui;
225         
226         /* Individual Spacetypes */
227         ThemeSpace tbuts;       
228         ThemeSpace tv3d;
229         ThemeSpace tfile;
230         ThemeSpace tipo;
231         ThemeSpace tinfo;       
232         ThemeSpace tsnd;
233         ThemeSpace tact;
234         ThemeSpace tnla;
235         ThemeSpace tseq;
236         ThemeSpace tima;
237         ThemeSpace timasel;
238         ThemeSpace text;
239         ThemeSpace toops;
240         ThemeSpace ttime;
241         ThemeSpace tnode;
242         
243         /* 20 sets of bone colors for this theme */
244         ThemeWireColor tarm[20];
245         /*ThemeWireColor tobj[20];*/
246         
247 } bTheme;
248
249 typedef struct SolidLight {
250         int flag, pad;
251         float col[4], spec[4], vec[4];
252 } SolidLight;
253
254 typedef struct UserDef {
255         int flag, dupflag;
256         int savetime;
257         char tempdir[160];      // FILE_MAXDIR length
258         char fontdir[160];
259         char renderdir[160];
260         char textudir[160];
261         char plugtexdir[160];
262         char plugseqdir[160];
263         char pythondir[160];
264         char sounddir[160];
265         /* yafray: temporary xml export directory */
266         char yfexportdir[160];
267         short versions, pad;
268         
269         int gameflags;
270         int wheellinescroll;
271         int uiflag, language;
272         short userpref, viewzoom;
273         
274         int mixbufsize;
275         int pad1;
276         int dpi;                /* range 48-128? */
277         short encoding;
278         short transopts;
279         short menuthreshold1, menuthreshold2;
280         
281         struct ListBase themes;
282         struct ListBase uifonts;
283         struct ListBase uistyles;
284         
285         short undosteps;
286         short undomemory;
287         short gp_manhattendist, gp_euclideandist, gp_eraser;
288         short gp_settings;
289         short tb_leftmouse, tb_rightmouse;
290         struct SolidLight light[3];
291         short tw_hotspot, tw_flag, tw_handlesize, tw_size;
292         short textimeout,texcollectrate;
293         short wmdrawmethod, wmpad;
294         int memcachelimit;
295         int prefetchframes;
296         short frameserverport;
297         short pad_rot_angle;    /*control the rotation step of the view when PAD2,PAD4,PAD6&PAD8 is use*/
298         short obcenter_dia;
299         short rvisize;                  /* rotating view icon size */
300         short rvibright;                /* rotating view icon brightness */
301         short recent_files;             /* maximum number of recently used files to remember  */
302         short smooth_viewtx;    /* miliseconds to spend spinning the view */
303         short glreslimit;
304         short ndof_pan, ndof_rotate;
305         short curssize, ipo_new;
306
307         char versemaster[160];
308         char verseuser[160];
309         float glalphaclip;
310         
311         short autokey_mode;             /* autokeying mode */
312         short autokey_flag;             /* flags for autokeying */
313
314         struct ColorBand coba_weight;   /* from texture.h */
315 } UserDef;
316
317 extern UserDef U; /* from blenkernel blender.c */
318
319 /* ***************** USERDEF ****************** */
320
321 /* flag */
322 #define USER_AUTOSAVE                   (1 << 0)
323 #define USER_AUTOGRABGRID               (1 << 1)
324 #define USER_AUTOROTGRID                (1 << 2)
325 #define USER_AUTOSIZEGRID               (1 << 3)
326 #define USER_SCENEGLOBAL                (1 << 4)
327 #define USER_TRACKBALL                  (1 << 5)
328 #define USER_DUPLILINK                  (1 << 6)
329 #define USER_FSCOLLUM                   (1 << 7)
330 #define USER_MAT_ON_OB                  (1 << 8)
331 /*#define USER_NO_CAPSLOCK              (1 << 9)*/ /* not used anywhere */
332 #define USER_VIEWMOVE                   (1 << 10)
333 #define USER_TOOLTIPS                   (1 << 11)
334 #define USER_TWOBUTTONMOUSE             (1 << 12)
335 #define USER_NONUMPAD                   (1 << 13)
336 #define USER_LMOUSESELECT               (1 << 14)
337 #define USER_FILECOMPRESS               (1 << 15)
338 #define USER_SAVE_PREVIEWS              (1 << 16)
339 #define USER_CUSTOM_RANGE               (1 << 17)
340 #define USER_ADD_EDITMODE               (1 << 18)
341 #define USER_ADD_VIEWALIGNED    (1 << 19)
342 #define USER_RELPATHS                   (1 << 20)
343 #define USER_DRAGIMMEDIATE              (1 << 21)
344 #define USER_DONT_DOSCRIPTLINKS (1 << 22)
345
346 /* viewzom */
347 #define USER_ZOOM_CONT                  0
348 #define USER_ZOOM_SCALE                 1
349 #define USER_ZOOM_DOLLY                 2
350
351 /* uiflag */
352 // old flag for #define USER_KEYINSERTACT               (1 << 0)
353 // old flag for #define USER_KEYINSERTOBJ               (1 << 1)
354 #define USER_WHEELZOOMDIR               (1 << 2)
355 #define USER_FILTERFILEEXTS             (1 << 3)
356 #define USER_DRAWVIEWINFO               (1 << 4)
357 #define USER_PLAINMENUS                 (1 << 5)                // old EVTTOCONSOLE print ghost events, here for tuhopuu compat. --phase
358                                                                 // old flag for hide pulldown was here 
359 #define USER_FLIPFULLSCREEN             (1 << 7)
360 #define USER_ALLWINCODECS               (1 << 8)
361 #define USER_MENUOPENAUTO               (1 << 9)
362 #define USER_PANELPINNED                (1 << 10)
363 #define USER_AUTOPERSP                  (1 << 11)
364 #define USER_LOCKAROUND         (1 << 12)
365 #define USER_GLOBALUNDO         (1 << 13)
366 #define USER_ORBIT_SELECTION    (1 << 14)
367 // old flag for #define USER_KEYINSERTAVAI              (1 << 15)
368 #define USER_ORBIT_ZBUF                 (1 << 15)
369 #define USER_HIDE_DOT                   (1 << 16)
370 #define USER_SHOW_ROTVIEWICON   (1 << 17)
371 #define USER_SHOW_VIEWPORTNAME  (1 << 18)
372 // old flag for #define USER_KEYINSERTNEED              (1 << 19)
373 #define USER_ZOOM_TO_MOUSEPOS   (1 << 20)
374 #define USER_SHOW_FPS                   (1 << 21)
375 #define USER_MMB_PASTE                  (1 << 22)
376
377 /* Auto-Keying mode */
378         /* AUTOKEY_ON is a bitflag */
379 #define         AUTOKEY_ON                              1
380         /* AUTOKEY_ON + 2**n...  (i.e. AUTOKEY_MODE_NORMAL = AUTOKEY_ON + 2) to preserve setting, even when autokey turned off  */
381 #define         AUTOKEY_MODE_NORMAL             3
382 #define         AUTOKEY_MODE_EDITKEYS   5
383
384 /* Auto-Keying flag */
385 #define         AUTOKEY_FLAG_INSERTAVAIL        (1<<0)
386 #define         AUTOKEY_FLAG_INSERTNEEDED       (1<<1)
387 #define         AUTOKEY_FLAG_AUTOMATKEY         (1<<2)
388
389
390 /* transopts */
391 #define USER_TR_TOOLTIPS                (1 << 0)
392 #define USER_TR_BUTTONS                 (1 << 1)
393 #define USER_TR_MENUS                   (1 << 2)
394 #define USER_TR_FILESELECT              (1 << 3)
395 #define USER_TR_TEXTEDIT                (1 << 4)
396 #define USER_DOTRANSLATE                (1 << 5)
397 #define USER_USETEXTUREFONT             (1 << 6)
398 #define CONVERT_TO_UTF8                 (1 << 7)
399
400 /* dupflag */
401 #define USER_DUP_MESH                   (1 << 0)
402 #define USER_DUP_CURVE                  (1 << 1)
403 #define USER_DUP_SURF                   (1 << 2)
404 #define USER_DUP_FONT                   (1 << 3)
405 #define USER_DUP_MBALL                  (1 << 4)
406 #define USER_DUP_LAMP                   (1 << 5)
407 #define USER_DUP_IPO                    (1 << 6)
408 #define USER_DUP_MAT                    (1 << 7)
409 #define USER_DUP_TEX                    (1 << 8)
410 #define USER_DUP_ARM                    (1 << 9)
411 #define USER_DUP_ACT                    (1 << 10)
412
413 /* gameflags */
414 #define USER_DEPRECATED_FLAG    1
415 #define USER_DISABLE_SOUND              2
416 #define USER_DISABLE_MIPMAP             4
417
418 /* wm draw method */
419 #define USER_DRAW_TRIPLE                0
420 #define USER_DRAW_OVERLAP               1
421 #define USER_DRAW_FULL                  2
422
423 /* tw_flag (transform widget) */
424
425 /* gp_settings (Grease Pencil Settings) */
426 #define GP_PAINT_DOSMOOTH               (1<<0)
427 #define GP_PAINT_DOSIMPLIFY             (1<<1)
428
429 /* theme drawtypes */
430 #define TH_MINIMAL      0
431 #define TH_ROUNDSHADED  1
432 #define TH_ROUNDED      2
433 #define TH_OLDSKOOL     3
434 #define TH_SHADED       4
435
436 #endif