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