Dope Sheet: remove many hard-coded color and alpha constants.
[blender.git] / source / blender / makesdna / DNA_userdef_types.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
28 /** \file DNA_userdef_types.h
29  *  \ingroup DNA
30  *  \since mar-2001
31  *  \author nzc
32  */
33
34 #ifndef __DNA_USERDEF_TYPES_H__
35 #define __DNA_USERDEF_TYPES_H__
36
37 #include "DNA_listBase.h"
38 #include "DNA_texture_types.h" /* ColorBand */
39
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43
44 /* themes; defines in BIF_resource.h */
45 struct ColorBand;
46
47 /* ************************ style definitions ******************** */
48
49 #define MAX_STYLE_NAME  64
50
51 #define GPU_VIEWPORT_QUALITY_FXAA 0.10f
52 #define GPU_VIEWPORT_QUALITY_TAA8 0.25f
53 #define GPU_VIEWPORT_QUALITY_TAA16 0.6f
54 #define GPU_VIEWPORT_QUALITY_TAA32 0.8f
55
56 /* default offered by Blender.
57  * uiFont.uifont_id */
58 typedef enum eUIFont_ID {
59         UIFONT_DEFAULT  = 0,
60 /*      UIFONT_BITMAP   = 1 */ /* UNUSED */
61
62         /* free slots */
63         UIFONT_CUSTOM1  = 2,
64         UIFONT_CUSTOM2  = 3
65 } eUIFont_ID;
66
67 /* default fonts to load/initialize */
68 /* first font is the default (index 0), others optional */
69 typedef struct uiFont {
70         struct uiFont *next, *prev;
71         char filename[1024];/* 1024 = FILE_MAX */
72         short blf_id;           /* from blfont lib */
73         short uifont_id;        /* own id (eUIFont_ID) */
74         short r_to_l;           /* fonts that read from left to right */
75         short pad;
76 } uiFont;
77
78 /* this state defines appearance of text */
79 typedef struct uiFontStyle {
80         short uifont_id;                /* saved in file, 0 is default */
81         short points;                   /* actual size depends on 'global' dpi */
82         short kerning;                  /* unfitted or default kerning value. */
83         char word_wrap;                 /* enable word-wrap when drawing */
84         char pad[5];
85         short italic, bold;             /* style hint */
86         short shadow;                   /* value is amount of pixels blur */
87         short shadx, shady;             /* shadow offset in pixels */
88         short align;                    /* text align hint */
89         float shadowalpha;              /* total alpha */
90         float shadowcolor;              /* 1 value, typically white or black anyway */
91 } uiFontStyle;
92
93 /* uiFontStyle.align */
94 typedef enum eFontStyle_Align {
95         UI_STYLE_TEXT_LEFT              = 0,
96         UI_STYLE_TEXT_CENTER    = 1,
97         UI_STYLE_TEXT_RIGHT             = 2
98 } eFontStyle_Align;
99
100
101 /* this is fed to the layout engine and widget code */
102
103 typedef struct uiStyle {
104         struct uiStyle *next, *prev;
105
106         char name[64];                  /* MAX_STYLE_NAME */
107
108         uiFontStyle paneltitle;
109         uiFontStyle grouplabel;
110         uiFontStyle widgetlabel;
111         uiFontStyle widget;
112
113         float panelzoom;
114
115         short minlabelchars;    /* in characters */
116         short minwidgetchars;   /* in characters */
117
118         short columnspace;
119         short templatespace;
120         short boxspace;
121         short buttonspacex;
122         short buttonspacey;
123         short panelspace;
124         short panelouter;
125
126         short pad;
127 } uiStyle;
128
129 typedef struct uiWidgetColors {
130         char outline[4];
131         char inner[4];
132         char inner_sel[4];
133         char item[4];
134         char text[4];
135         char text_sel[4];
136         char shaded;
137         char _pad0[7];
138         short shadetop, shadedown;
139         float roundness;
140 } uiWidgetColors;
141
142 typedef struct uiWidgetStateColors {
143         char inner_anim[4];
144         char inner_anim_sel[4];
145         char inner_key[4];
146         char inner_key_sel[4];
147         char inner_driven[4];
148         char inner_driven_sel[4];
149         char inner_overridden[4];
150         char inner_overridden_sel[4];
151         float blend, pad;
152 } uiWidgetStateColors;
153
154 typedef struct uiPanelColors {
155         char header[4];
156         char back[4];
157         char sub_back[4];
158         char pad2[4];
159 } uiPanelColors;
160
161 typedef struct uiGradientColors {
162         char gradient[4];
163         char high_gradient[4];
164         int show_grad;
165         int pad2;
166 } uiGradientColors;
167
168 typedef struct ThemeUI {
169         /* Interface Elements (buttons, menus, icons) */
170         uiWidgetColors wcol_regular, wcol_tool, wcol_toolbar_item, wcol_text;
171         uiWidgetColors wcol_radio, wcol_option, wcol_toggle;
172         uiWidgetColors wcol_num, wcol_numslider, wcol_tab;
173         uiWidgetColors wcol_menu, wcol_pulldown, wcol_menu_back, wcol_menu_item, wcol_tooltip;
174         uiWidgetColors wcol_box, wcol_scroll, wcol_progress, wcol_list_item, wcol_pie_menu;
175
176         uiWidgetStateColors wcol_state;
177
178         uiPanelColors panel; /* deprecated, but we keep it for do_versions (2.66.1) */
179
180         char widget_emboss[4];
181
182         /* fac: 0 - 1 for blend factor, width in pixels */
183         float menu_shadow_fac;
184         short menu_shadow_width;
185
186         char editor_outline[4];
187         short pad[1];
188
189         char iconfile[256];     // FILE_MAXFILE length
190         float icon_alpha;
191         float icon_saturation;
192         char _pad[4];
193
194         /* Axis Colors */
195         char xaxis[4], yaxis[4], zaxis[4];
196
197         /* Gizmo Colors. */
198         char gizmo_hi[4];
199         char gizmo_primary[4];
200         char gizmo_secondary[4];
201         char gizmo_a[4];
202         char gizmo_b[4];
203
204         /* Icon Colors. */
205         char icon_collection[4];  /* Collection items */
206         char icon_object[4];      /* Object items */
207         char icon_object_data[4]; /* Object data items */
208         char icon_modifier[4];    /* Modifier and constraint items */
209         char icon_shading[4];     /* Shading related items */
210 } ThemeUI;
211
212 /* try to put them all in one, if needed a special struct can be created as well
213  * for example later on, when we introduce wire colors for ob types or so...
214  */
215 typedef struct ThemeSpace {
216         /* main window colors */
217         char back[4];
218         char title[4];  /* panel title */
219         char text[4];
220         char text_hi[4];
221
222         /* header colors */
223         char header[4];                 /* region background */
224         char header_title[4];   /* unused */
225         char header_text[4];
226         char header_text_hi[4];
227
228         /* region tabs */
229         char tab_active[4];
230         char tab_inactive[4];
231         char tab_back[4];
232         char tab_outline[4];
233
234         /* button/tool regions */
235         char button[4];                 /* region background */
236         char button_title[4];   /* panel title */
237         char button_text[4];
238         char button_text_hi[4];
239
240         /* listview regions */
241         char list[4];                   /* region background */
242         char list_title[4];     /* panel title */
243         char list_text[4];
244         char list_text_hi[4];
245
246         /* float panel */
247 /*      char panel[4];                  unused */
248 /*      char panel_title[4];    unused */
249 /*      char panel_text[4];             unused */
250 /*      char panel_text_hi[4];  unused */
251
252         /* note, cannot use name 'panel' because of DNA mapping old files */
253         uiPanelColors panelcolors;
254
255         uiGradientColors gradients;
256
257         char shade1[4];
258         char shade2[4];
259
260         char hilite[4];
261         char grid[4];
262
263         char view_overlay[4];
264
265         char wire[4], wire_edit[4], select[4];
266         char lamp[4], speaker[4], empty[4], camera[4];
267         char active[4], group[4], group_active[4], transform[4];
268         char vertex[4], vertex_select[4], vertex_bevel[4], vertex_unreferenced[4];
269         char edge[4], edge_select[4];
270         char edge_seam[4], edge_sharp[4], edge_facesel[4], edge_crease[4], edge_bevel[4];
271         char face[4], face_select[4];   /* solid faces */
272         char face_dot[4];                               /*  selected color */
273         char extra_edge_len[4], extra_edge_angle[4], extra_face_angle[4], extra_face_area[4];
274         char normal[4];
275         char vertex_normal[4];
276         char loop_normal[4];
277         char bone_solid[4], bone_pose[4], bone_pose_active[4];
278         char strip[4], strip_select[4];
279         char cframe[4];
280         char time_keyframe[4], time_gp_keyframe[4];
281         char freestyle_edge_mark[4], freestyle_face_mark[4];
282
283         char nurb_uline[4], nurb_vline[4];
284         char act_spline[4], nurb_sel_uline[4], nurb_sel_vline[4], lastsel_point[4];
285
286         char handle_free[4], handle_auto[4], handle_vect[4], handle_align[4], handle_auto_clamped[4];
287         char handle_sel_free[4], handle_sel_auto[4], handle_sel_vect[4], handle_sel_align[4], handle_sel_auto_clamped[4];
288
289         char ds_channel[4], ds_subchannel[4]; /* dopesheet */
290         char keytype_keyframe[4], keytype_extreme[4], keytype_breakdown[4], keytype_jitter[4], keytype_movehold[4]; /* keytypes */
291         char keytype_keyframe_select[4], keytype_extreme_select[4], keytype_breakdown_select[4], keytype_jitter_select[4], keytype_movehold_select[4]; /* keytypes */
292         char keyborder[4], keyborder_select[4];
293
294         char console_output[4], console_input[4], console_info[4], console_error[4];
295         char console_cursor[4], console_select[4];
296
297         char vertex_size, outline_width, facedot_size;
298         char noodle_curving;
299
300         /* syntax for textwindow and nodes */
301         char syntaxl[4], syntaxs[4]; // in nodespace used for backdrop matte
302         char syntaxb[4], syntaxn[4]; // in nodespace used for color input
303         char syntaxv[4], syntaxc[4]; // in nodespace used for converter group
304         char syntaxd[4], syntaxr[4]; // in nodespace used for distort
305
306         char nodeclass_output[4], nodeclass_filter[4];
307         char nodeclass_vector[4], nodeclass_texture[4];
308         char nodeclass_shader[4], nodeclass_script[4];
309         char nodeclass_pattern[4], nodeclass_layout[4];
310
311         char movie[4], movieclip[4], mask[4], image[4], scene[4], audio[4];             /* for sequence editor */
312         char effect[4], transition[4], meta[4], text_strip[4];
313
314         float keyframe_scale_fac; /* for dopesheet - scale factor for size of keyframes (i.e. height of channels) */
315
316         char editmesh_active[4];
317
318         char handle_vertex[4];
319         char handle_vertex_select[4];
320
321         char handle_vertex_size;
322
323         char clipping_border_3d[4];
324
325         char marker_outline[4], marker[4], act_marker[4], sel_marker[4], dis_marker[4], lock_marker[4];
326         char bundle_solid[4];
327         char path_before[4], path_after[4];
328         char camera_path[4];
329         char hpad[2];
330
331         char gp_vertex_size;
332         char gp_vertex[4], gp_vertex_select[4];
333
334         char preview_back[4];
335         char preview_stitch_face[4];
336         char preview_stitch_edge[4];
337         char preview_stitch_vert[4];
338         char preview_stitch_stitchable[4];
339         char preview_stitch_unstitchable[4];
340         char preview_stitch_active[4];
341
342         char uv_shadow[4]; /* two uses, for uvs with modifier applied on mesh and uvs during painting */
343         char uv_others[4]; /* uvs of other objects */
344
345         char match[4];                          /* outliner - filter match */
346         char selected_highlight[4];     /* outliner - selected item */
347
348         char skin_root[4]; /* Skin modifier root color */
349
350         /* NLA */
351         char anim_active[4];     /* Active Action + Summary Channel */
352         char anim_non_active[4]; /* Active Action = NULL */
353         char anim_preview_range[4]; /* Preview range overlay */
354         char anim_pad[4];
355
356         char nla_tweaking[4];   /* NLA 'Tweaking' action/strip */
357         char nla_tweakdupli[4]; /* NLA - warning color for duplicate instances of tweaking strip */
358
359         char nla_transition[4], nla_transition_sel[4]; /* NLA "Transition" strips */
360         char nla_meta[4], nla_meta_sel[4];             /* NLA "Meta" strips */
361         char nla_sound[4], nla_sound_sel[4];           /* NLA "Sound" strips */
362
363         /* info */
364         char info_selected[4], info_selected_text[4];
365         char info_error[4], info_error_text[4];
366         char info_warning[4], info_warning_text[4];
367         char info_info[4], info_info_text[4];
368         char info_debug[4], info_debug_text[4];
369
370         char paint_curve_pivot[4];
371         char paint_curve_handle[4];
372
373         char metadatabg[4];
374         char metadatatext[4];
375 } ThemeSpace;
376
377
378 /* set of colors for use as a custom color set for Objects/Bones wire drawing */
379 typedef struct ThemeWireColor {
380         char    solid[4];
381         char    select[4];
382         char    active[4];
383
384         short   flag;  /* eWireColor_Flags */
385         short   pad;
386 } ThemeWireColor;
387
388 /* ThemeWireColor.flag */
389 typedef enum eWireColor_Flags {
390         TH_WIRECOLOR_CONSTCOLS  = (1 << 0),
391         TH_WIRECOLOR_TEXTCOLS   = (1 << 1),
392 } eWireColor_Flags;
393
394 /* A theme */
395 typedef struct bTheme {
396         struct bTheme *next, *prev;
397         char name[32];
398
399         ThemeUI tui;
400
401         /* Individual Spacetypes */
402         /* note: ensure UI_THEMESPACE_END is updated when adding */
403         ThemeSpace tbuts;
404         ThemeSpace tv3d;
405         ThemeSpace tfile;
406         ThemeSpace tipo;
407         ThemeSpace tinfo;
408         ThemeSpace tact;
409         ThemeSpace tnla;
410         ThemeSpace tseq;
411         ThemeSpace tima;
412         ThemeSpace text;
413         ThemeSpace toops;
414         ThemeSpace ttime;
415         ThemeSpace tnode;
416         ThemeSpace tuserpref;
417         ThemeSpace tconsole;
418         ThemeSpace tclip;
419         ThemeSpace ttopbar;
420         ThemeSpace tstatusbar;
421
422         /* 20 sets of bone colors for this theme */
423         ThemeWireColor tarm[20];
424         /*ThemeWireColor tobj[20];*/
425
426         int active_theme_area, pad;
427 } bTheme;
428
429 #define UI_THEMESPACE_START(btheme)  (CHECK_TYPE_INLINE(btheme, bTheme *),  &((btheme)->tbuts))
430 #define UI_THEMESPACE_END(btheme)    (CHECK_TYPE_INLINE(btheme, bTheme *), (&((btheme)->tclip) + 1))
431
432 typedef struct bAddon {
433         struct bAddon *next, *prev;
434         char module[64];
435         IDProperty *prop;  /* User-Defined Properties on this  Addon (for storing preferences) */
436 } bAddon;
437
438 typedef struct bPathCompare {
439         struct bPathCompare *next, *prev;
440         char path[768];  /* FILE_MAXDIR */
441         char flag, pad[7];
442 } bPathCompare;
443
444 typedef struct bUserMenu {
445         struct bUserMenu *next, *prev;
446         char space_type;
447         char _pad0[7];
448         char context[64];
449         /* bUserMenuItem */
450         ListBase items;
451 } bUserMenu;
452
453 /* May be part of bUserMenu or other list. */
454 typedef struct bUserMenuItem {
455         struct bUserMenuItem *next, *prev;
456         char ui_name[64];
457         char type;
458         char _pad0[7];
459 } bUserMenuItem;
460
461 typedef struct bUserMenuItem_Op {
462         bUserMenuItem item;
463         char op_idname[64];
464         struct IDProperty *prop;
465         char opcontext;
466         char _pad0[7];
467 } bUserMenuItem_Op;
468
469 typedef struct bUserMenuItem_Menu {
470         bUserMenuItem item;
471         char mt_idname[64];
472 } bUserMenuItem_Menu;
473
474 typedef struct bUserMenuItem_Prop {
475         bUserMenuItem item;
476         char context_data_path[256];
477         char prop_id[64];
478         int  prop_index;
479         char _pad0[4];
480 } bUserMenuItem_Prop;
481
482 enum {
483         USER_MENU_TYPE_SEP = 1,
484         USER_MENU_TYPE_OPERATOR = 2,
485         USER_MENU_TYPE_MENU = 3,
486         USER_MENU_TYPE_PROP = 4,
487 };
488
489 typedef struct SolidLight {
490         int flag, pad;
491         float col[4], spec[4], vec[4];
492 } SolidLight;
493
494 typedef struct WalkNavigation {
495         float mouse_speed;  /* speed factor for look around */
496         float walk_speed;
497         float walk_speed_factor;
498         float view_height;
499         float jump_height;
500         float teleport_time;  /* duration to use for teleporting */
501         short flag;
502         short pad[3];
503 } WalkNavigation;
504
505 typedef struct UserDef {
506         /* UserDef has separate do-version handling, and can be read from other files */
507         int versionfile, subversionfile;
508
509         int flag;  /* eUserPref_Flag */
510         int dupflag;  /* eDupli_ID_Flags */
511         int savetime;
512         char tempdir[768];      /* FILE_MAXDIR length */
513         char fontdir[768];
514         char renderdir[1024]; /* FILE_MAX length */
515         /* EXR cache path */
516         char render_cachedir[768];  /* 768 = FILE_MAXDIR */
517         char textudir[768];
518         char pythondir[768];
519         char sounddir[768];
520         char i18ndir[768];
521         char image_editor[1024];    /* 1024 = FILE_MAX */
522         char anim_player[1024];     /* 1024 = FILE_MAX */
523         int anim_player_preset;
524
525         short v2d_min_gridsize;         /* minimum spacing between gridlines in View2D grids */
526         short timecode_style;           /* eTimecodeStyles, style of timecode display */
527
528         short versions;
529         short dbl_click_time;
530
531         short pad;
532         short wheellinescroll;
533         int uiflag;   /* eUserpref_UI_Flag */
534         int uiflag2;  /* eUserpref_UI_Flag2 */
535         /* Experimental flag for app-templates to make changes to behavior
536          * which are outside the scope of typical preferences. */
537         short app_flag;
538         short language;
539         short userpref, viewzoom;
540
541         int mixbufsize;
542         int audiodevice;
543         int audiorate;
544         int audioformat;
545         int audiochannels;
546
547         float ui_scale;     /* setting for UI scale */
548         int ui_line_width;  /* setting for UI line width */
549         int dpi;            /* runtime, full DPI divided by pixelsize */
550         float dpi_fac;      /* runtime, multiplier to scale UI elements based on DPI */
551         float pixelsize;        /* runtime, line width and point size based on DPI */
552         int virtual_pixel;      /* deprecated, for forward compatibility */
553
554         int scrollback;     /* console scrollback limit */
555         char node_margin;   /* node insert offset (aka auto-offset) margin, but might be useful for later stuff as well */
556         char pad2[5];
557         short transopts;    /* eUserpref_Translation_Flags */
558         short menuthreshold1, menuthreshold2;
559
560         /* startup template */
561         char app_template[64];
562
563         struct ListBase themes;
564         struct ListBase uifonts;
565         struct ListBase uistyles;
566         struct ListBase keymaps  DNA_DEPRECATED; /* deprecated in favor of user_keymaps */
567         struct ListBase user_keymaps;
568         struct ListBase addons;
569         struct ListBase autoexec_paths;
570         struct ListBase user_menus; /* bUserMenu */
571
572         char keyconfigstr[64];
573
574         short undosteps;
575         short pad1;
576         int undomemory;
577         float gpu_viewport_quality;
578         short gp_manhattendist, gp_euclideandist, gp_eraser;
579         short gp_settings;  /* eGP_UserdefSettings */
580         short tb_leftmouse, tb_rightmouse;
581         struct SolidLight light[3];
582         short gizmo_flag, gizmo_size;
583         short pad6[3];
584         short textimeout, texcollectrate;
585         short dragthreshold;
586         int memcachelimit;
587         int prefetchframes;
588         float pad_rot_angle; /* control the rotation step of the view when PAD2, PAD4, PAD6&PAD8 is use */
589         short _pad0;
590         short obcenter_dia;
591         short rvisize;                  /* rotating view icon size */
592         short rvibright;                /* rotating view icon brightness */
593         short recent_files;             /* maximum number of recently used files to remember  */
594         short smooth_viewtx;    /* milliseconds to spend spinning the view */
595         short glreslimit;
596         short curssize;
597         short color_picker_type;  /* eColorPicker_Types */
598         char  ipo_new;                  /* interpolation mode for newly added F-Curves */
599         char  keyhandles_new;   /* handle types for newly added keyframes */
600         char  gpu_select_method;
601         char  gpu_select_pick_deph;
602         char  pad0;
603         char  view_frame_type;  /* eZoomFrame_Mode */
604
605         int view_frame_keyframes; /* number of keyframes to zoom around current frame */
606         float view_frame_seconds; /* seconds to zoom around current frame */
607
608         char _pad1[4];
609
610         short widget_unit;              /* private, defaults to 20 for 72 DPI setting */
611         short anisotropic_filter;
612         short use_16bit_textures, use_gpu_mipmap;
613
614         float ndof_sensitivity; /* overall sensitivity of 3D mouse */
615         float ndof_orbit_sensitivity;
616         float ndof_deadzone; /* deadzone of 3D mouse */
617         int ndof_flag;                  /* eNdof_Flag, flags for 3D mouse */
618
619         short ogl_multisamples; /* eMultiSample_Type, amount of samples for OpenGL FSA, if zero no FSA */
620
621         /* eImageDrawMethod, Method to be used to draw the images (AUTO, GLSL, Textures or DrawPixels) */
622         short image_draw_method;
623
624         float glalphaclip;
625
626         short autokey_mode;             /* eAutokey_Mode, autokeying mode */
627         short autokey_flag;             /* flags for autokeying */
628
629         short text_render, pad9;                /* options for text rendering */
630
631         struct ColorBand coba_weight;   /* from texture.h */
632
633         float sculpt_paint_overlay_col[3];
634         float gpencil_new_layer_col[4]; /* default color for newly created Grease Pencil layers */
635
636         short tweak_threshold;
637         char navigation_mode, pad10;
638
639         char author[80];        /* author name for file formats supporting it */
640
641         char font_path_ui[1024];
642         char font_path_ui_mono[1024];
643
644         int compute_device_type;
645         int compute_device_id;
646
647         float fcu_inactive_alpha;       /* opacity of inactive F-Curves in F-Curve Editor */
648
649         short pie_interaction_type;     /* if keeping a pie menu spawn button pressed after this time, it turns into
650                                      * a drag/release pie menu */
651         short pie_initial_timeout;  /* direction in the pie menu will always be calculated from the initial position
652                                      * within this time limit */
653         short pie_animation_timeout;
654         short pie_menu_confirm;
655         short pie_menu_radius;        /* pie menu radius */
656         short pie_menu_threshold;     /* pie menu distance from center before a direction is set */
657
658         struct WalkNavigation walk_navigation;
659
660         short opensubdiv_compute_type;
661         short gpencil_multisamples;     /* eMultiSample_Type, amount of samples for Grease Pencil */
662
663         char pad5[4];
664 } UserDef;
665
666 extern UserDef U; /* from blenkernel blender.c */
667
668 /* ***************** USERDEF ****************** */
669
670 /* UserDef.userpref (UI active_section) */
671 typedef enum eUserPref_Section {
672         USER_SECTION_INTERFACE  = 0,
673         USER_SECTION_EDIT               = 1,
674         USER_SECTION_FILE               = 2,
675         USER_SECTION_SYSTEM             = 3,
676         USER_SECTION_THEME              = 4,
677         USER_SECTION_INPUT              = 5,
678         USER_SECTION_ADDONS     = 6,
679         USER_SECTION_LIGHT      = 7,
680 } eUserPref_Section;
681
682 /* UserDef.flag */
683 typedef enum eUserPref_Flag {
684         USER_AUTOSAVE                   = (1 << 0),
685         USER_FLAG_NUMINPUT_ADVANCED = (1 << 1),
686         USER_FLAG_DEPRECATED_2  = (1 << 2),  /* cleared */
687         USER_FLAG_DEPRECATED_3  = (1 << 3),  /* cleared */
688 /*      USER_SCENEGLOBAL         = (1 << 4), deprecated */
689         USER_TRACKBALL                  = (1 << 5),
690         USER_FLAG_DEPRECATED_6  = (1 << 6),  /* cleared */
691         USER_FLAG_DEPRECATED_7  = (1 << 7),  /* cleared */
692         USER_MAT_ON_OB                  = (1 << 8),
693         USER_FLAG_DEPRECATED_9  = (1 << 9),   /* cleared */
694         USER_DEVELOPER_UI               = (1 << 10),
695         USER_TOOLTIPS                   = (1 << 11),
696         USER_TWOBUTTONMOUSE             = (1 << 12),
697         USER_NONUMPAD                   = (1 << 13),
698         USER_LMOUSESELECT               = (1 << 14),
699         USER_FILECOMPRESS               = (1 << 15),
700         USER_SAVE_PREVIEWS              = (1 << 16),
701         USER_CUSTOM_RANGE               = (1 << 17),
702         USER_ADD_EDITMODE               = (1 << 18),
703         USER_ADD_VIEWALIGNED    = (1 << 19),
704         USER_RELPATHS                   = (1 << 20),
705         USER_RELEASECONFIRM             = (1 << 21),
706         USER_SCRIPT_AUTOEXEC_DISABLE    = (1 << 22),
707         USER_FILENOUI                   = (1 << 23),
708         USER_NONEGFRAMES                = (1 << 24),
709         USER_TXT_TABSTOSPACES_DISABLE   = (1 << 25),
710         USER_TOOLTIPS_PYTHON    = (1 << 26),
711 } eUserPref_Flag;
712
713 /* bPathCompare.flag */
714 typedef enum ePathCompare_Flag {
715         USER_PATHCMP_GLOB               = (1 << 0),
716 } ePathCompare_Flag;
717
718 /* helper macro for checking frame clamping */
719 #define FRAMENUMBER_MIN_CLAMP(cfra)  {                                        \
720         if ((U.flag & USER_NONEGFRAMES) && (cfra < 0))                            \
721                 cfra = 0;                                                             \
722         } (void)0
723
724 /* UserDef.viewzoom */
725 typedef enum eViewZoom_Style {
726         USER_ZOOM_CONT                  = 0,
727         USER_ZOOM_SCALE                 = 1,
728         USER_ZOOM_DOLLY                 = 2
729 } eViewZoom_Style;
730
731 /* UserDef.navigation_mode */
732 typedef enum eViewNavigation_Method {
733         VIEW_NAVIGATION_WALK = 0,
734         VIEW_NAVIGATION_FLY  = 1,
735 } eViewNavigation_Method;
736
737 /* UserDef.flag */
738 typedef enum eWalkNavigation_Flag {
739         USER_WALK_GRAVITY                       = (1 << 0),
740         USER_WALK_MOUSE_REVERSE         = (1 << 1),
741 } eWalkNavigation_Flag;
742
743 /* UserDef.uiflag */
744 typedef enum eUserpref_UI_Flag {
745         /* flags 0 and 1 were old flags (for autokeying) that aren't used anymore */
746         USER_WHEELZOOMDIR               = (1 << 2),
747         USER_FILTERFILEEXTS             = (1 << 3),
748         USER_DRAWVIEWINFO               = (1 << 4),
749         USER_PLAINMENUS                 = (1 << 5),
750         USER_LOCK_CURSOR_ADJUST = (1 << 6),
751         /* Avoid accidentally adjusting the layout
752          * (exact behavior may change based on what's considered reasonable to lock down). */
753         USER_UIFLAG_DEPRECATED_7 = (1 << 7),
754         USER_ALLWINCODECS               = (1 << 8),
755         USER_MENUOPENAUTO               = (1 << 9),
756         USER_DEPTH_CURSOR               = (1 << 10),
757         USER_AUTOPERSP                  = (1 << 11),
758         /* USER_LOCKAROUND      = (1 << 12), */  /* DEPRECATED */
759         USER_GLOBALUNDO         = (1 << 13),
760         USER_ORBIT_SELECTION    = (1 << 14),
761         USER_DEPTH_NAVIGATE     = (1 << 15),
762         USER_HIDE_DOT                   = (1 << 16),
763         USER_SHOW_GIZMO_AXIS    = (1 << 17),
764         USER_SHOW_VIEWPORTNAME  = (1 << 18),
765         USER_CAM_LOCK_NO_PARENT = (1 << 19),
766         USER_ZOOM_TO_MOUSEPOS   = (1 << 20),
767         USER_SHOW_FPS                   = (1 << 21),
768         USER_MMB_PASTE                  = (1 << 22),
769         USER_MENUFIXEDORDER             = (1 << 23),
770         USER_CONTINUOUS_MOUSE   = (1 << 24),
771         USER_ZOOM_INVERT                = (1 << 25),
772         USER_ZOOM_HORIZ                 = (1 << 26), /* for CONTINUE and DOLLY zoom */
773         USER_SPLASH_DISABLE             = (1 << 27),
774         USER_HIDE_RECENT                = (1 << 28),
775         USER_SHOW_THUMBNAILS    = (1 << 29),
776         USER_QUIT_PROMPT                = (1 << 30),
777         USER_HIDE_SYSTEM_BOOKMARKS = (1u << 31)
778 } eUserpref_UI_Flag;
779
780 /* UserDef.uiflag2 */
781 typedef enum eUserpref_UI_Flag2 {
782         USER_KEEP_SESSION                       = (1 << 0),
783         USER_REGION_OVERLAP                     = (1 << 1),
784         USER_TRACKPAD_NATURAL           = (1 << 2),
785 } eUserpref_UI_Flag2;
786
787 /* UserDef.app_flag */
788 typedef enum eUserpref_APP_Flag {
789         USER_APP_LOCK_UI_LAYOUT = (1 << 0),
790         USER_APP_VIEW3D_HIDE_CURSOR = (1 << 1),
791 } eUserpref_APP_Flag;
792
793 /* Auto-Keying mode.
794  * UserDef.autokey_mode */
795 typedef enum eAutokey_Mode {
796         /* AUTOKEY_ON is a bitflag */
797         AUTOKEY_ON             = 1,
798
799         /* AUTOKEY_ON + 2**n...  (i.e. AUTOKEY_MODE_NORMAL = AUTOKEY_ON + 2) to preserve setting, even when autokey turned off  */
800         AUTOKEY_MODE_NORMAL    = 3,
801         AUTOKEY_MODE_EDITKEYS  = 5
802 } eAutokey_Mode;
803
804 /* Zoom to frame mode.
805  * UserDef.view_frame_type */
806 typedef enum eZoomFrame_Mode {
807         ZOOM_FRAME_MODE_KEEP_RANGE = 0,
808         ZOOM_FRAME_MODE_SECONDS = 1,
809         ZOOM_FRAME_MODE_KEYFRAMES = 2
810 } eZoomFrame_Mode;
811
812 /* Auto-Keying flag
813  * U.autokey_flag (not strictly used when autokeying only - is also used when keyframing these days)
814  * note: AUTOKEY_FLAG_* is used with a macro, search for lines like IS_AUTOKEY_FLAG(INSERTAVAIL)
815  */
816 typedef enum eAutokey_Flag {
817         AUTOKEY_FLAG_INSERTAVAIL        = (1 << 0),
818         AUTOKEY_FLAG_INSERTNEEDED       = (1 << 1),
819         AUTOKEY_FLAG_AUTOMATKEY         = (1 << 2),
820         AUTOKEY_FLAG_XYZ2RGB            = (1 << 3),
821
822         /* toolsettings->autokey_flag */
823         AUTOKEY_FLAG_ONLYKEYINGSET      = (1 << 6),
824         AUTOKEY_FLAG_NOWARNING          = (1 << 7),
825         ANIMRECORD_FLAG_WITHNLA         = (1 << 10),
826 } eAutokey_Flag;
827
828 /* UserDef.transopts */
829 typedef enum eUserpref_Translation_Flags {
830         USER_TR_TOOLTIPS                = (1 << 0),
831         USER_TR_IFACE                   = (1 << 1),
832         USER_TR_DEPRECATED_2    = (1 << 2),  /* cleared */
833         USER_TR_DEPRECATED_3    = (1 << 3),  /* cleared */
834         USER_TR_DEPRECATED_4    = (1 << 4),  /* cleared */
835         USER_DOTRANSLATE                = (1 << 5),
836         USER_TR_DEPRECATED_6    = (1 << 6),  /* cleared */
837         USER_TR_DEPRECATED_7    = (1 << 7),  /* cleared */
838         USER_TR_NEWDATANAME             = (1 << 8),
839 } eUserpref_Translation_Flags;
840
841 /* UserDef.dupflag */
842 typedef enum eDupli_ID_Flags {
843         USER_DUP_MESH                   = (1 << 0),
844         USER_DUP_CURVE                  = (1 << 1),
845         USER_DUP_SURF                   = (1 << 2),
846         USER_DUP_FONT                   = (1 << 3),
847         USER_DUP_MBALL                  = (1 << 4),
848         USER_DUP_LAMP                   = (1 << 5),
849         USER_DUP_IPO                    = (1 << 6),
850         USER_DUP_MAT                    = (1 << 7),
851         USER_DUP_TEX                    = (1 << 8),
852         USER_DUP_ARM                    = (1 << 9),
853         USER_DUP_ACT                    = (1 << 10),
854         USER_DUP_PSYS                   = (1 << 11)
855 } eDupli_ID_Flags;
856
857 /* selection method for opengl gpu_select_method */
858 typedef enum eOpenGL_SelectOptions {
859         USER_SELECT_AUTO = 0,
860         USER_SELECT_USE_OCCLUSION_QUERY = 1,
861         USER_SELECT_USE_SELECT_RENDERMODE = 2
862 } eOpenGL_SelectOptions;
863
864 /* max anti alias draw method UserDef.gpu_viewport_antialias */
865 typedef enum eOpenGL_AntiAliasMethod {
866         USER_AA_NONE  = 0,
867         USER_AA_FXAA  = 1,
868         USER_AA_TAA8  = 2,
869 } eOpenGL_AntiAliasMethod;
870
871 /* text draw options
872  * UserDef.text_render */
873 typedef enum eText_Draw_Options {
874         USER_TEXT_DISABLE_AA      = (1 << 0),
875
876         USER_TEXT_HINTING_NONE    = (1 << 1),
877         USER_TEXT_HINTING_SLIGHT  = (1 << 2),
878         USER_TEXT_HINTING_FULL    = (1 << 3),
879 } eText_Draw_Options;
880
881 /* tw_flag (transform widget) */
882
883 /* Grease Pencil Settings.
884  * UserDef.gp_settings */
885 typedef enum eGP_UserdefSettings {
886         GP_PAINT_DOSMOOTH                   = (1 << 0),
887         GP_PAINT_DOSIMPLIFY                 = (1 << 1),
888 } eGP_UserdefSettings;
889
890 enum {
891         USER_GIZMO_DRAW            = (1 << 0),
892 };
893
894 /* Color Picker Types.
895  * UserDef.color_picker_type */
896 typedef enum eColorPicker_Types {
897         USER_CP_CIRCLE_HSV      = 0,
898         USER_CP_SQUARE_SV       = 1,
899         USER_CP_SQUARE_HS       = 2,
900         USER_CP_SQUARE_HV       = 3,
901         USER_CP_CIRCLE_HSL      = 4,
902 } eColorPicker_Types;
903
904 /* timecode display styles
905  * UserDef.timecode_style */
906 typedef enum eTimecodeStyles {
907         /* as little info as is necessary to show relevant info
908          * with '+' to denote the frames
909          * i.e. HH:MM:SS+FF, MM:SS+FF, SS+FF, or MM:SS
910          */
911         USER_TIMECODE_MINIMAL       = 0,
912
913         /* reduced SMPTE - (HH:)MM:SS:FF */
914         USER_TIMECODE_SMPTE_MSF     = 1,
915
916         /* full SMPTE - HH:MM:SS:FF */
917         USER_TIMECODE_SMPTE_FULL    = 2,
918
919         /* milliseconds for sub-frames - HH:MM:SS.sss */
920         USER_TIMECODE_MILLISECONDS  = 3,
921
922         /* seconds only */
923         USER_TIMECODE_SECONDS_ONLY  = 4,
924
925         /* Private (not exposed as generic choices) options. */
926         /* milliseconds for sub-frames , SubRip format- HH:MM:SS,sss */
927         USER_TIMECODE_SUBRIP        = 100,
928 } eTimecodeStyles;
929
930 /* theme drawtypes */
931 /* XXX: These are probably only for the old UI engine? */
932 typedef enum eTheme_DrawTypes {
933         TH_MINIMAL      = 0,
934         TH_ROUNDSHADED  = 1,
935         TH_ROUNDED      = 2,
936         TH_OLDSKOOL     = 3,
937         TH_SHADED       = 4
938 } eTheme_DrawTypes;
939
940 /* UserDef.ndof_flag (3D mouse options) */
941 typedef enum eNdof_Flag {
942         NDOF_SHOW_GUIDE     = (1 << 0),
943         NDOF_FLY_HELICOPTER = (1 << 1),
944         NDOF_LOCK_HORIZON   = (1 << 2),
945
946         /* the following might not need to be saved between sessions,
947          * but they do need to live somewhere accessible... */
948         NDOF_SHOULD_PAN     = (1 << 3),
949         NDOF_SHOULD_ZOOM    = (1 << 4),
950         NDOF_SHOULD_ROTATE  = (1 << 5),
951
952         /* orbit navigation modes */
953
954         /* exposed as Orbit|Explore in the UI */
955         NDOF_MODE_ORBIT      = (1 << 6),
956
957         /* actually... users probably don't care about what the mode
958          * is called, just that it feels right */
959         /* zoom is up/down if this flag is set (otherwise forward/backward) */
960         NDOF_PAN_YZ_SWAP_AXIS   = (1 << 7),
961         NDOF_ZOOM_INVERT        = (1 << 8),
962         NDOF_ROTX_INVERT_AXIS   = (1 << 9),
963         NDOF_ROTY_INVERT_AXIS   = (1 << 10),
964         NDOF_ROTZ_INVERT_AXIS   = (1 << 11),
965         NDOF_PANX_INVERT_AXIS   = (1 << 12),
966         NDOF_PANY_INVERT_AXIS   = (1 << 13),
967         NDOF_PANZ_INVERT_AXIS   = (1 << 14),
968         NDOF_TURNTABLE          = (1 << 15),
969 } eNdof_Flag;
970
971 #define NDOF_PIXELS_PER_SECOND 600.0f
972
973 /* UserDef.ogl_multisamples and gpencil_multisamples */
974 typedef enum eMultiSample_Type {
975         USER_MULTISAMPLE_NONE   = 0,
976         USER_MULTISAMPLE_2      = 2,
977         USER_MULTISAMPLE_4      = 4,
978         USER_MULTISAMPLE_8      = 8,
979         USER_MULTISAMPLE_16     = 16,
980 } eMultiSample_Type;
981
982 /* UserDef.image_draw_method */
983 typedef enum eImageDrawMethod {
984         /* IMAGE_DRAW_METHOD_AUTO = 0, */ /* Currently unused */
985         IMAGE_DRAW_METHOD_GLSL = 1,
986         IMAGE_DRAW_METHOD_2DTEXTURE = 2,
987         IMAGE_DRAW_METHOD_DRAWPIXELS = 3,
988 } eImageDrawMethod;
989
990 /* UserDef.virtual_pixel */
991 typedef enum eUserpref_VirtualPixel {
992         VIRTUAL_PIXEL_NATIVE = 0,
993         VIRTUAL_PIXEL_DOUBLE = 1,
994 } eUserpref_VirtualPixel;
995
996 typedef enum eOpensubdiv_Computee_Type {
997         USER_OPENSUBDIV_COMPUTE_NONE = 0,
998         USER_OPENSUBDIV_COMPUTE_CPU = 1,
999         USER_OPENSUBDIV_COMPUTE_OPENMP = 2,
1000         USER_OPENSUBDIV_COMPUTE_OPENCL = 3,
1001         USER_OPENSUBDIV_COMPUTE_CUDA = 4,
1002         USER_OPENSUBDIV_COMPUTE_GLSL_TRANSFORM_FEEDBACK = 5,
1003         USER_OPENSUBDIV_COMPUTE_GLSL_COMPUTE = 6,
1004 } eOpensubdiv_Computee_Type;
1005
1006 #ifdef __cplusplus
1007 }
1008 #endif
1009
1010 #endif