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