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