source/blender/makesdna/DNA_userdef_types.h

   1 /**
   2  * blenkernel/DNA_userdef_types.h (mar-2001 nzc)
   3  *
   4  *      $Id$
   5  *
   6  * ***** BEGIN GPL LICENSE BLOCK *****
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * as published by the Free Software Foundation; either version 2
  11  * of the License, or (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software Foundation,
  20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  21  *
  22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
  23  * All rights reserved.
  24  *
  25  * The Original Code is: all of this file.
  26  *
  27  * Contributor(s): none yet.
  28  *
  29  * ***** END GPL LICENSE BLOCK *****
  30 */
  31
  32 #ifndef DNA_USERDEF_TYPES_H
  33 #define DNA_USERDEF_TYPES_H
  34
  35 #include "DNA_listBase.h"
  36 #include "DNA_texture_types.h"
  37
  38 /* themes; defines in BIF_resource.h */
  39 struct ColorBand;
  40
  41 /* ************************ style definitions ******************** */
  42
  43 #define MAX_STYLE_NAME  64
  44 #define MAX_FONT_NAME   256
  45
  46 /* default uifont_id offered by Blender */
  47 #define UIFONT_DEFAULT  0
  48 #define UIFONT_BITMAP   1
  49 /* free slots */
  50 #define UIFONT_CUSTOM1  2
  51 #define UIFONT_CUSTOM2  3
  52
  53 /* default fonts to load/initalize */
  54 /* first font is the default (index 0), others optional */
  55 typedef struct uiFont {
  56         struct uiFont *next, *prev;
  57         char filename[256];
  58         short blf_id;           /* from blfont lib */
  59         short uifont_id;        /* own id */
  60         short r_to_l;           /* fonts that read from left to right */
  61         short pad;
  62
  63 } uiFont;
  64
  65 /* this state defines appearance of text */
  66 typedef struct uiFontStyle {
  67         short uifont_id;                /* saved in file, 0 is default */
  68         short points;                   /* actual size depends on 'global' dpi */
  69         short kerning;                  /* unfitted or default kerning value. */
  70         char pad[6];
  71         short italic, bold;             /* style hint */
  72         short shadow;                   /* value is amount of pixels blur */
  73         short shadx, shady;             /* shadow offset in pixels */
  74         short align;                    /* text align hint */
  75         float shadowalpha;              /* total alpha */
  76         float shadowcolor;              /* 1 value, typically white or black anyway */
  77
  78 } uiFontStyle;
  79
  80 /* uiFontStyle->align */
  81 #define UI_STYLE_TEXT_LEFT              0
  82 #define UI_STYLE_TEXT_CENTER    1
  83 #define UI_STYLE_TEXT_RIGHT             2
  84
  85
  86 /* this is fed to the layout engine and widget code */
  87 typedef struct uiStyle {
  88         struct uiStyle *next, *prev;
  89
  90         char name[64];                  /* MAX_STYLE_NAME */
  91
  92         uiFontStyle paneltitle;
  93         uiFontStyle grouplabel;
  94         uiFontStyle widgetlabel;
  95         uiFontStyle widget;
  96
  97         float panelzoom;
  98
  99         short minlabelchars;    /* in characters */
 100         short minwidgetchars;   /* in characters */
 101
 102         short columnspace;
 103         short templatespace;
 104         short boxspace;
 105         short buttonspacex;
 106         short buttonspacey;
 107         short panelspace;
 108         short panelouter;
 109
 110         short pad[1];
 111 } uiStyle;
 112
 113 typedef struct uiWidgetColors {
 114         char outline[4];
 115         char inner[4];
 116         char inner_sel[4];
 117         char item[4];
 118         char text[4];
 119         char text_sel[4];
 120         short shaded;
 121         short shadetop, shadedown;
 122         short pad;
 123 } uiWidgetColors;
 124
 125 typedef struct uiWidgetStateColors {
 126         char inner_anim[4];
 127         char inner_anim_sel[4];
 128         char inner_key[4];
 129         char inner_key_sel[4];
 130         char inner_driven[4];
 131         char inner_driven_sel[4];
 132         float blend, pad;
 133 } uiWidgetStateColors;
 134
 135 typedef struct ThemeUI {
 136
 137         /* Interface Elements (buttons, menus, icons) */
 138         uiWidgetColors wcol_regular, wcol_tool, wcol_text;
 139         uiWidgetColors wcol_radio, wcol_option, wcol_toggle;
 140         uiWidgetColors wcol_num, wcol_numslider;
 141         uiWidgetColors wcol_menu, wcol_pulldown, wcol_menu_back, wcol_menu_item;
 142         uiWidgetColors wcol_box, wcol_scroll, wcol_list_item;
 143
 144         uiWidgetStateColors wcol_state;
 145
 146         char iconfile[80];      // FILE_MAXFILE length
 147
 148 } ThemeUI;
 149
 150 /* try to put them all in one, if needed a special struct can be created as well
 151  * for example later on, when we introduce wire colors for ob types or so...
 152  */
 153 typedef struct ThemeSpace {
 154         /* main window colors */
 155         char back[4];
 156         char title[4];
 157         char text[4];
 158         char text_hi[4];
 159
 160         /* header colors */
 161         char header[4];
 162         char header_title[4];
 163         char header_text[4];
 164         char header_text_hi[4];
 165
 166         /* button/tool regions */
 167         char button[4];
 168         char button_title[4];
 169         char button_text[4];
 170         char button_text_hi[4];
 171
 172         /* listview regions */
 173         char list[4];
 174         char list_title[4];
 175         char list_text[4];
 176         char list_text_hi[4];
 177
 178         /* float panel */
 179         char panel[4];
 180         char panel_title[4];
 181         char panel_text[4];
 182         char panel_text_hi[4];
 183
 184         char shade1[4];
 185         char shade2[4];
 186
 187         char hilite[4];
 188         char grid[4];
 189
 190         char wire[4], select[4];
 191         char lamp[4];
 192         char active[4], group[4], group_active[4], transform[4];
 193         char vertex[4], vertex_select[4];
 194         char edge[4], edge_select[4];
 195         char edge_seam[4], edge_sharp[4], edge_facesel[4];
 196         char face[4], face_select[4];   // solid faces
 197         char face_dot[4];                               // selected color
 198         char normal[4];
 199         char bone_solid[4], bone_pose[4];
 200         char strip[4], strip_select[4];
 201         char cframe[4];
 202         char ds_channel[4], ds_subchannel[4]; // dopesheet
 203
 204         char vertex_size, facedot_size;
 205         char bpad[2];
 206
 207         char syntaxl[4], syntaxn[4], syntaxb[4]; // syntax for textwindow and nodes
 208         char syntaxv[4], syntaxc[4];
 209
 210         char movie[4], image[4], scene[4], audio[4];            // for sequence editor
 211         char effect[4], plugin[4], transition[4], meta[4];
 212         char editmesh_active[4];
 213
 214         char handle_vertex[4];
 215         char handle_vertex_select[4];
 216
 217         char handle_vertex_size;
 218         char hpad[3];
 219
 220         char pad[4];
 221
 222 } ThemeSpace;
 223
 224
 225 /* set of colors for use as a custom color set for Objects/Bones wire drawing */
 226 typedef struct ThemeWireColor {
 227         char    solid[4];
 228         char    select[4];
 229         char    active[4];
 230
 231         short   flag;
 232         short   pad;
 233 } ThemeWireColor;
 234
 235 /* flags for ThemeWireColor */
 236 #define TH_WIRECOLOR_CONSTCOLS  (1<<0)
 237 #define TH_WIRECOLOR_TEXTCOLS   (1<<1)
 238
 239 /* A theme */
 240 typedef struct bTheme {
 241         struct bTheme *next, *prev;
 242         char name[32];
 243
 244         ThemeUI tui;
 245
 246         /* Individual Spacetypes */
 247         ThemeSpace tbuts;
 248         ThemeSpace tv3d;
 249         ThemeSpace tfile;
 250         ThemeSpace tipo;
 251         ThemeSpace tinfo;
 252         ThemeSpace tsnd;
 253         ThemeSpace tact;
 254         ThemeSpace tnla;
 255         ThemeSpace tseq;
 256         ThemeSpace tima;
 257         ThemeSpace timasel;
 258         ThemeSpace text;
 259         ThemeSpace toops;
 260         ThemeSpace ttime;
 261         ThemeSpace tnode;
 262         ThemeSpace tlogic;
 263         ThemeSpace tuserpref;
 264
 265         /* 20 sets of bone colors for this theme */
 266         ThemeWireColor tarm[20];
 267         /*ThemeWireColor tobj[20];*/
 268
 269         int active_theme_group, pad;
 270
 271 } bTheme;
 272
 273 typedef struct SolidLight {
 274         int flag, pad;
 275         float col[4], spec[4], vec[4];
 276 } SolidLight;
 277
 278 typedef struct UserDef {
 279         int flag, dupflag;
 280         int savetime;
 281         char tempdir[160];      // FILE_MAXDIR length
 282         char fontdir[160];
 283         char renderdir[160];
 284         char textudir[160];
 285         char plugtexdir[160];
 286         char plugseqdir[160];
 287         char pythondir[160];
 288         char sounddir[160];
 289         char anim_player[240];  // FILE_MAX length
 290         int anim_player_preset;
 291         int pad;
 292
 293         short versions;
 294         short dbl_click_time;
 295
 296         int gameflags;
 297         int wheellinescroll;
 298         int uiflag, language;
 299         short userpref, viewzoom;
 300
 301         int mixbufsize;
 302         int audiodevice;
 303         int audiorate;
 304         int audioformat;
 305         int audiochannels;
 306
 307         int scrollback; /* console scrollback limit */
 308         int dpi;                /* range 48-128? */
 309         short encoding;
 310         short transopts;
 311         short menuthreshold1, menuthreshold2;
 312
 313         struct ListBase themes;
 314         struct ListBase uifonts;
 315         struct ListBase uistyles;
 316         struct ListBase keymaps;
 317         char keyconfigstr[64];
 318
 319         short undosteps;
 320         short undomemory;
 321         short gp_manhattendist, gp_euclideandist, gp_eraser;
 322         short gp_settings;
 323         short tb_leftmouse, tb_rightmouse;
 324         struct SolidLight light[3];
 325         short tw_hotspot, tw_flag, tw_handlesize, tw_size;
 326         short textimeout,texcollectrate;
 327         short wmdrawmethod, wmpad;
 328         int memcachelimit;
 329         int prefetchframes;
 330         short frameserverport;
 331         short pad_rot_angle;    /*control the rotation step of the view when PAD2,PAD4,PAD6&PAD8 is use*/
 332         short obcenter_dia;
 333         short rvisize;                  /* rotating view icon size */
 334         short rvibright;                /* rotating view icon brightness */
 335         short recent_files;             /* maximum number of recently used files to remember  */
 336         short smooth_viewtx;    /* miliseconds to spend spinning the view */
 337         short glreslimit;
 338         short ndof_pan, ndof_rotate;
 339         short curssize, ipo_new;
 340
 341         char versemaster[160];
 342         char verseuser[160];
 343         float glalphaclip;
 344
 345         short autokey_mode;             /* autokeying mode */
 346         short autokey_flag;             /* flags for autokeying */
 347
 348         struct ColorBand coba_weight;   /* from texture.h */
 349 } UserDef;
 350
 351 extern UserDef U; /* from blenkernel blender.c */
 352
 353 /* ***************** USERDEF ****************** */
 354
 355 /* userpref/section */
 356 #define USER_SECTION_INTERFACE  0
 357 #define USER_SECTION_EDIT               1
 358 #define USER_SECTION_FILE               2
 359 #define USER_SECTION_SYSTEM             3
 360 #define USER_SECTION_THEME              4
 361 #define USER_SECTION_INPUT              5
 362
 363 /* flag */
 364 #define USER_AUTOSAVE                   (1 << 0)
 365 #define USER_AUTOGRABGRID               (1 << 1)
 366 #define USER_AUTOROTGRID                (1 << 2)
 367 #define USER_AUTOSIZEGRID               (1 << 3)
 368 #define USER_SCENEGLOBAL                (1 << 4)
 369 #define USER_TRACKBALL                  (1 << 5)
 370 #define USER_DUPLILINK                  (1 << 6)
 371 #define USER_FSCOLLUM                   (1 << 7)
 372 #define USER_MAT_ON_OB                  (1 << 8)
 373 /*#define USER_NO_CAPSLOCK              (1 << 9)*/ /* not used anywhere */
 374 #define USER_VIEWMOVE                   (1 << 10)
 375 #define USER_TOOLTIPS                   (1 << 11)
 376 #define USER_TWOBUTTONMOUSE             (1 << 12)
 377 #define USER_NONUMPAD                   (1 << 13)
 378 #define USER_LMOUSESELECT               (1 << 14)
 379 #define USER_FILECOMPRESS               (1 << 15)
 380 #define USER_SAVE_PREVIEWS              (1 << 16)
 381 #define USER_CUSTOM_RANGE               (1 << 17)
 382 #define USER_ADD_EDITMODE               (1 << 18)
 383 #define USER_ADD_VIEWALIGNED    (1 << 19)
 384 #define USER_RELPATHS                   (1 << 20)
 385 #define USER_DRAGIMMEDIATE              (1 << 21)
 386 #define USER_DONT_DOSCRIPTLINKS (1 << 22)
 387 #define USER_FILENOUI                   (1 << 23)
 388
 389 /* viewzom */
 390 #define USER_ZOOM_CONT                  0
 391 #define USER_ZOOM_SCALE                 1
 392 #define USER_ZOOM_DOLLY                 2
 393
 394 /* uiflag */
 395 // old flag for #define USER_KEYINSERTACT               (1 << 0)
 396 // old flag for #define USER_KEYINSERTOBJ               (1 << 1)
 397 #define USER_WHEELZOOMDIR               (1 << 2)
 398 #define USER_FILTERFILEEXTS             (1 << 3)
 399 #define USER_DRAWVIEWINFO               (1 << 4)
 400 #define USER_PLAINMENUS                 (1 << 5)                // old EVTTOCONSOLE print ghost events, here for tuhopuu compat. --phase
 401                                                                 // old flag for hide pulldown was here
 402 #define USER_FLIPFULLSCREEN             (1 << 7)
 403 #define USER_ALLWINCODECS               (1 << 8)
 404 #define USER_MENUOPENAUTO               (1 << 9)
 405 #define USER_PANELPINNED                (1 << 10)
 406 #define USER_AUTOPERSP                  (1 << 11)
 407 #define USER_LOCKAROUND         (1 << 12)
 408 #define USER_GLOBALUNDO         (1 << 13)
 409 #define USER_ORBIT_SELECTION    (1 << 14)
 410 // old flag for #define USER_KEYINSERTAVAI              (1 << 15)
 411 #define USER_ORBIT_ZBUF                 (1 << 15)
 412 #define USER_HIDE_DOT                   (1 << 16)
 413 #define USER_SHOW_ROTVIEWICON   (1 << 17)
 414 #define USER_SHOW_VIEWPORTNAME  (1 << 18)
 415 // old flag for #define USER_KEYINSERTNEED              (1 << 19)
 416 #define USER_ZOOM_TO_MOUSEPOS   (1 << 20)
 417 #define USER_SHOW_FPS                   (1 << 21)
 418 #define USER_MMB_PASTE                  (1 << 22)
 419 #define USER_MENUFIXEDORDER             (1 << 23)
 420 #define USER_CONTINUOUS_MOUSE   (1 << 24)
 421 #define USER_ZOOM_INVERT                (1 << 25)
 422 #define USER_ZOOM_DOLLY_HORIZ   (1 << 26)
 423
 424 /* Auto-Keying mode */
 425         /* AUTOKEY_ON is a bitflag */
 426 #define         AUTOKEY_ON                              1
 427         /* AUTOKEY_ON + 2**n...  (i.e. AUTOKEY_MODE_NORMAL = AUTOKEY_ON + 2) to preserve setting, even when autokey turned off  */
 428 #define         AUTOKEY_MODE_NORMAL             3
 429 #define         AUTOKEY_MODE_EDITKEYS   5
 430
 431 /* Auto-Keying flag */
 432         /* U.autokey_flag (not strictly used when autokeying only - is also used when keyframing these days) */
 433 #define         AUTOKEY_FLAG_INSERTAVAIL        (1<<0)
 434 #define         AUTOKEY_FLAG_INSERTNEEDED       (1<<1)
 435 #define         AUTOKEY_FLAG_AUTOMATKEY         (1<<2)
 436 #define         AUTOKEY_FLAG_XYZ2RGB            (1<<3)
 437         /* U.autokey_flag (strictly autokeying only) */
 438 #define         AUTOKEY_FLAG_ONLYKEYINGSET      (1<<6)
 439         /* toolsettings->autokey_flag */
 440 #define         ANIMRECORD_FLAG_WITHNLA         (1<<10)
 441
 442 /* transopts */
 443 #define USER_TR_TOOLTIPS                (1 << 0)
 444 #define USER_TR_BUTTONS                 (1 << 1)
 445 #define USER_TR_MENUS                   (1 << 2)
 446 #define USER_TR_FILESELECT              (1 << 3)
 447 #define USER_TR_TEXTEDIT                (1 << 4)
 448 #define USER_DOTRANSLATE                (1 << 5)
 449 #define USER_USETEXTUREFONT             (1 << 6)
 450 #define CONVERT_TO_UTF8                 (1 << 7)
 451
 452 /* dupflag */
 453 #define USER_DUP_MESH                   (1 << 0)
 454 #define USER_DUP_CURVE                  (1 << 1)
 455 #define USER_DUP_SURF                   (1 << 2)
 456 #define USER_DUP_FONT                   (1 << 3)
 457 #define USER_DUP_MBALL                  (1 << 4)
 458 #define USER_DUP_LAMP                   (1 << 5)
 459 #define USER_DUP_IPO                    (1 << 6)
 460 #define USER_DUP_MAT                    (1 << 7)
 461 #define USER_DUP_TEX                    (1 << 8)
 462 #define USER_DUP_ARM                    (1 << 9)
 463 #define USER_DUP_ACT                    (1 << 10)
 464 #define USER_DUP_PSYS                   (1 << 11)
 465
 466 /* gameflags */
 467 #define USER_DEPRECATED_FLAG    1
 468 #define USER_DISABLE_SOUND              2
 469 #define USER_DISABLE_MIPMAP             4
 470 #define USER_DISABLE_VBO                8
 471 #define USER_DISABLE_AA                 16
 472
 473 /* wm draw method */
 474 #define USER_DRAW_TRIPLE                0
 475 #define USER_DRAW_OVERLAP               1
 476 #define USER_DRAW_FULL                  2
 477
 478 /* tw_flag (transform widget) */
 479
 480 /* gp_settings (Grease Pencil Settings) */
 481 #define GP_PAINT_DOSMOOTH               (1<<0)
 482 #define GP_PAINT_DOSIMPLIFY             (1<<1)
 483
 484 /* theme drawtypes */
 485 #define TH_MINIMAL      0
 486 #define TH_ROUNDSHADED  1
 487 #define TH_ROUNDED      2
 488 #define TH_OLDSKOOL     3
 489 #define TH_SHADED       4
 490
 491 #endif