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