- respect insert available with pose copy/paste (note: autokeyframe_pose_cb_func...
[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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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 vertex_normal[4];
200         char bone_solid[4], bone_pose[4];
201         char strip[4], strip_select[4];
202         char cframe[4];
203         char ds_channel[4], ds_subchannel[4]; // dopesheet
204         
205         char console_output[4], console_input[4], console_info[4], console_error[4];
206         char console_cursor[4];
207         
208         char vertex_size, facedot_size;
209         char bpad[2];
210
211         char syntaxl[4], syntaxn[4], syntaxb[4]; // syntax for textwindow and nodes
212         char syntaxv[4], syntaxc[4];
213         
214         char movie[4], image[4], scene[4], audio[4];            // for sequence editor
215         char effect[4], plugin[4], transition[4], meta[4];
216         char editmesh_active[4]; 
217
218         char handle_vertex[4];
219         char handle_vertex_select[4];
220         
221         char handle_vertex_size;
222         char hpad[3];
223         
224         char preview_back[4];
225         
226 } ThemeSpace;
227
228
229 /* set of colors for use as a custom color set for Objects/Bones wire drawing */
230 typedef struct ThemeWireColor {
231         char    solid[4];
232         char    select[4];
233         char    active[4];
234         
235         short   flag;
236         short   pad;
237 } ThemeWireColor; 
238
239 /* flags for ThemeWireColor */
240 #define TH_WIRECOLOR_CONSTCOLS  (1<<0)
241 #define TH_WIRECOLOR_TEXTCOLS   (1<<1)
242
243 /* A theme */
244 typedef struct bTheme {
245         struct bTheme *next, *prev;
246         char name[32];
247         
248         ThemeUI tui;
249         
250         /* Individual Spacetypes */
251         ThemeSpace tbuts;       
252         ThemeSpace tv3d;
253         ThemeSpace tfile;
254         ThemeSpace tipo;
255         ThemeSpace tinfo;       
256         ThemeSpace tsnd;
257         ThemeSpace tact;
258         ThemeSpace tnla;
259         ThemeSpace tseq;
260         ThemeSpace tima;
261         ThemeSpace timasel;
262         ThemeSpace text;
263         ThemeSpace toops;
264         ThemeSpace ttime;
265         ThemeSpace tnode;
266         ThemeSpace tlogic;
267         ThemeSpace tuserpref;   
268         ThemeSpace tconsole;
269         
270         /* 20 sets of bone colors for this theme */
271         ThemeWireColor tarm[20];
272         /*ThemeWireColor tobj[20];*/
273         
274         int active_theme_area, pad;
275         
276 } bTheme;
277
278 /* for the moment only the name. may want to store options with this later */
279 typedef struct bExtension {
280         struct bExtension *next, *prev;
281         char module[64];
282 } bExtension;
283
284 typedef struct SolidLight {
285         int flag, pad;
286         float col[4], spec[4], vec[4];
287 } SolidLight;
288
289 typedef struct UserDef {
290         int flag, dupflag;
291         int savetime;
292         char tempdir[160];      // FILE_MAXDIR length
293         char fontdir[160];
294         char renderdir[160];
295         char textudir[160];
296         char plugtexdir[160];
297         char plugseqdir[160];
298         char pythondir[160];
299         char sounddir[160];
300         char anim_player[240];  // FILE_MAX length
301         int anim_player_preset;
302         
303         short v2d_min_gridsize;         /* minimum spacing between gridlines in View2D grids */
304         short timecode_style;           /* style of timecode display */
305         
306         short versions;
307         short dbl_click_time;
308         
309         int gameflags;
310         int wheellinescroll;
311         int uiflag, language;
312         short userpref, viewzoom;
313         
314         int mixbufsize;
315         int audiodevice;
316         int audiorate;
317         int audioformat;
318         int audiochannels;
319
320         int scrollback; /* console scrollback limit */
321         int dpi;                /* range 48-128? */
322         short encoding;
323         short transopts;
324         short menuthreshold1, menuthreshold2;
325         
326         struct ListBase themes;
327         struct ListBase uifonts;
328         struct ListBase uistyles;
329         struct ListBase keymaps;
330         struct ListBase extensions;
331         char keyconfigstr[64];
332         
333         short undosteps;
334         short undomemory;
335         short gp_manhattendist, gp_euclideandist, gp_eraser;
336         short gp_settings;
337         short tb_leftmouse, tb_rightmouse;
338         struct SolidLight light[3];
339         short tw_hotspot, tw_flag, tw_handlesize, tw_size;
340         short textimeout,texcollectrate;
341         short wmdrawmethod, wmpad;
342         int memcachelimit;
343         int prefetchframes;
344         short frameserverport;
345         short pad_rot_angle;    /*control the rotation step of the view when PAD2,PAD4,PAD6&PAD8 is use*/
346         short obcenter_dia;
347         short rvisize;                  /* rotating view icon size */
348         short rvibright;                /* rotating view icon brightness */
349         short recent_files;             /* maximum number of recently used files to remember  */
350         short smooth_viewtx;    /* miliseconds to spend spinning the view */
351         short glreslimit;
352         short ndof_pan, ndof_rotate;
353         short curssize, ipo_new;
354         short color_picker_type;
355         short pad2;
356
357         short scrcastfps;               /* frame rate for screencast to be played back */
358         short scrcastwait;              /* milliseconds between screencast snapshots */
359
360         char versemaster[160];
361         char verseuser[160];
362         float glalphaclip;
363         
364         short autokey_mode;             /* autokeying mode */
365         short autokey_flag;             /* flags for autokeying */
366
367         struct ColorBand coba_weight;   /* from texture.h */
368 } UserDef;
369
370 extern UserDef U; /* from blenkernel blender.c */
371
372 /* ***************** USERDEF ****************** */
373
374 /* userpref/section */
375 #define USER_SECTION_INTERFACE  0
376 #define USER_SECTION_EDIT               1
377 #define USER_SECTION_FILE               2
378 #define USER_SECTION_SYSTEM             3
379 #define USER_SECTION_THEME              4
380 #define USER_SECTION_INPUT              5
381 #define USER_SECTION_EXTENSIONS 6
382
383 /* flag */
384 #define USER_AUTOSAVE                   (1 << 0)
385 #define USER_AUTOGRABGRID               (1 << 1)
386 #define USER_AUTOROTGRID                (1 << 2)
387 #define USER_AUTOSIZEGRID               (1 << 3)
388 #define USER_SCENEGLOBAL                (1 << 4)
389 #define USER_TRACKBALL                  (1 << 5)
390 #define USER_DUPLILINK                  (1 << 6)
391 #define USER_FSCOLLUM                   (1 << 7)
392 #define USER_MAT_ON_OB                  (1 << 8)
393 /*#define USER_NO_CAPSLOCK              (1 << 9)*/ /* not used anywhere */
394 #define USER_VIEWMOVE                   (1 << 10)
395 #define USER_TOOLTIPS                   (1 << 11)
396 #define USER_TWOBUTTONMOUSE             (1 << 12)
397 #define USER_NONUMPAD                   (1 << 13)
398 #define USER_LMOUSESELECT               (1 << 14)
399 #define USER_FILECOMPRESS               (1 << 15)
400 #define USER_SAVE_PREVIEWS              (1 << 16)
401 #define USER_CUSTOM_RANGE               (1 << 17)
402 #define USER_ADD_EDITMODE               (1 << 18)
403 #define USER_ADD_VIEWALIGNED    (1 << 19)
404 #define USER_RELPATHS                   (1 << 20)
405 #define USER_DRAGIMMEDIATE              (1 << 21)
406 #define USER_DONT_DOSCRIPTLINKS (1 << 22)
407 #define USER_FILENOUI                   (1 << 23)
408 #define USER_NONEGFRAMES                (1 << 24)
409
410 /* helper macro for checking frame clamping */
411 #define FRAMENUMBER_MIN_CLAMP(cfra) \
412         { \
413                 if ((U.flag & USER_NONEGFRAMES) && (cfra < 0)) \
414                         cfra = 0; \
415         }
416
417 /* viewzom */
418 #define USER_ZOOM_CONT                  0
419 #define USER_ZOOM_SCALE                 1
420 #define USER_ZOOM_DOLLY                 2
421
422 /* uiflag */
423 // old flag for #define USER_KEYINSERTACT               (1 << 0)
424 // old flag for #define USER_KEYINSERTOBJ               (1 << 1)
425 #define USER_WHEELZOOMDIR               (1 << 2)
426 #define USER_FILTERFILEEXTS             (1 << 3)
427 #define USER_DRAWVIEWINFO               (1 << 4)
428 #define USER_PLAINMENUS                 (1 << 5)                // old EVTTOCONSOLE print ghost events, here for tuhopuu compat. --phase
429                                                                 // old flag for hide pulldown was here 
430 #define USER_FLIPFULLSCREEN             (1 << 7)
431 #define USER_ALLWINCODECS               (1 << 8)
432 #define USER_MENUOPENAUTO               (1 << 9)
433 #define USER_PANELPINNED                (1 << 10)
434 #define USER_AUTOPERSP                  (1 << 11)
435 #define USER_LOCKAROUND         (1 << 12)
436 #define USER_GLOBALUNDO         (1 << 13)
437 #define USER_ORBIT_SELECTION    (1 << 14)
438 // old flag for #define USER_KEYINSERTAVAI              (1 << 15)
439 #define USER_ORBIT_ZBUF                 (1 << 15)
440 #define USER_HIDE_DOT                   (1 << 16)
441 #define USER_SHOW_ROTVIEWICON   (1 << 17)
442 #define USER_SHOW_VIEWPORTNAME  (1 << 18)
443 // old flag for #define USER_KEYINSERTNEED              (1 << 19)
444 #define USER_ZOOM_TO_MOUSEPOS   (1 << 20)
445 #define USER_SHOW_FPS                   (1 << 21)
446 #define USER_MMB_PASTE                  (1 << 22)
447 #define USER_MENUFIXEDORDER             (1 << 23)
448 #define USER_CONTINUOUS_MOUSE   (1 << 24)
449 #define USER_ZOOM_INVERT                (1 << 25)
450 #define USER_ZOOM_DOLLY_HORIZ   (1 << 26)
451
452 /* Auto-Keying mode */
453         /* AUTOKEY_ON is a bitflag */
454 #define         AUTOKEY_ON                              1
455         /* AUTOKEY_ON + 2**n...  (i.e. AUTOKEY_MODE_NORMAL = AUTOKEY_ON + 2) to preserve setting, even when autokey turned off  */
456 #define         AUTOKEY_MODE_NORMAL             3
457 #define         AUTOKEY_MODE_EDITKEYS   5
458
459 /* Auto-Keying flag
460  * U.autokey_flag (not strictly used when autokeying only - is also used when keyframing these days)
461  * note: AUTOKEY_FLAG_* is used with a macro, search for lines like IS_AUTOKEY_FLAG(INSERTAVAIL)
462  */
463 #define         AUTOKEY_FLAG_INSERTAVAIL        (1<<0)
464 #define         AUTOKEY_FLAG_INSERTNEEDED       (1<<1)
465 #define         AUTOKEY_FLAG_AUTOMATKEY         (1<<2)
466 #define         AUTOKEY_FLAG_XYZ2RGB            (1<<3)
467         /* U.autokey_flag (strictly autokeying only) */
468 #define         AUTOKEY_FLAG_ONLYKEYINGSET      (1<<6)
469         /* toolsettings->autokey_flag */
470 #define         ANIMRECORD_FLAG_WITHNLA         (1<<10)
471
472 /* transopts */
473 #define USER_TR_TOOLTIPS                (1 << 0)
474 #define USER_TR_BUTTONS                 (1 << 1)
475 #define USER_TR_MENUS                   (1 << 2)
476 #define USER_TR_FILESELECT              (1 << 3)
477 #define USER_TR_TEXTEDIT                (1 << 4)
478 #define USER_DOTRANSLATE                (1 << 5)
479 #define USER_USETEXTUREFONT             (1 << 6)
480 #define CONVERT_TO_UTF8                 (1 << 7)
481
482 /* dupflag */
483 #define USER_DUP_MESH                   (1 << 0)
484 #define USER_DUP_CURVE                  (1 << 1)
485 #define USER_DUP_SURF                   (1 << 2)
486 #define USER_DUP_FONT                   (1 << 3)
487 #define USER_DUP_MBALL                  (1 << 4)
488 #define USER_DUP_LAMP                   (1 << 5)
489 #define USER_DUP_IPO                    (1 << 6)
490 #define USER_DUP_MAT                    (1 << 7)
491 #define USER_DUP_TEX                    (1 << 8)
492 #define USER_DUP_ARM                    (1 << 9)
493 #define USER_DUP_ACT                    (1 << 10)
494 #define USER_DUP_PSYS                   (1 << 11)
495
496 /* gameflags */
497 #define USER_DEPRECATED_FLAG    1
498 // #define USER_DISABLE_SOUND           2 deprecated, don't use without checking for
499 // backwards compatibilty in do_versions!
500 #define USER_DISABLE_MIPMAP             4
501 #define USER_DISABLE_VBO                8
502 #define USER_DISABLE_AA                 16
503
504 /* wm draw method */
505 #define USER_DRAW_TRIPLE                0
506 #define USER_DRAW_OVERLAP               1
507 #define USER_DRAW_FULL                  2
508 #define USER_DRAW_AUTOMATIC             3
509 #define USER_DRAW_OVERLAP_FLIP  4
510
511 /* tw_flag (transform widget) */
512
513 /* gp_settings (Grease Pencil Settings) */
514 #define GP_PAINT_DOSMOOTH               (1<<0)
515 #define GP_PAINT_DOSIMPLIFY             (1<<1)
516
517 /* color picker types */
518 #define USER_CP_CIRCLE          0
519 #define USER_CP_SQUARE_SV       1
520 #define USER_CP_SQUARE_HS       2
521 #define USER_CP_SQUARE_HV       3
522
523 /* timecode display styles */
524         /* as little info as is necessary to show relevant info
525          * with '+' to denote the frames 
526          * i.e. HH:MM:SS+FF, MM:SS+FF, SS+FF, or MM:SS
527          */
528 #define USER_TIMECODE_MINIMAL           0
529         /* reduced SMPTE - (HH:)MM:SS:FF */
530 #define USER_TIMECODE_SMPTE_MSF         1
531         /* full SMPTE - HH:MM:SS:FF */
532 #define USER_TIMECODE_SMPTE_FULL        2
533         /* milliseconds for sub-frames - HH:MM:SS.sss */
534 #define USER_TIMECODE_MILLISECONDS      3
535         /* seconds only */
536 #define USER_TIMECODE_SECONDS_ONLY      4
537
538 /* theme drawtypes */
539 #define TH_MINIMAL      0
540 #define TH_ROUNDSHADED  1
541 #define TH_ROUNDED      2
542 #define TH_OLDSKOOL     3
543 #define TH_SHADED       4
544
545 #endif