DNA_screen_types.h

Go to the documentation of this file.

/*
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 */
 
#pragma once
 
#include "DNA_defs.h"
#include "DNA_listBase.h"
#include "DNA_vec_types.h"
#include "DNA_view2d_types.h"
 
#include "DNA_ID.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct ARegion;
struct ARegionType;
struct PanelType;
struct PointerRNA;
struct Scene;
struct SpaceLink;
struct SpaceType;
struct uiBlock;
struct uiLayout;
struct wmDrawBuffer;
struct wmTimer;
struct wmTooltipState;
 
/* TODO Doing this is quite ugly :)
 * Once the top-bar is merged bScreen should be refactored to use ScrAreaMap. */
#define AREAMAP_FROM_SCREEN(screen) ((ScrAreaMap *)&(screen)->vertbase)
 
typedef struct bScreen {
  ID id;
 
  /* TODO Should become ScrAreaMap now.
   * ** NOTE: KEEP ORDER IN SYNC WITH ScrAreaMap! (see AREAMAP_FROM_SCREEN macro above) ** */
  ListBase vertbase;
  ListBase edgebase;
  ListBase areabase;
 
  ListBase regionbase;
 
  struct Scene *scene DNA_DEPRECATED;
 
  short flag;
  short winid;
  short redraws_flag;
 
  char temp;
  char state;
  char do_draw;
  char do_refresh;
  char do_draw_gesture;
  char do_draw_paintcursor;
  char do_draw_drag;
  char skip_handling;
  char scrubbing;
  char _pad[1];
 
  struct ARegion *active_region;
 
  struct wmTimer *animtimer;
  void /*bContextDataCallback*/ *context;
 
  struct wmTooltipState *tool_tip;
 
  PreviewImage *preview;
} bScreen;
 
typedef struct ScrVert {
  struct ScrVert *next, *prev, *newv;
  vec2s vec;
  /* first one used internally, second one for tools */
  short flag, editflag;
} ScrVert;
 
typedef struct ScrEdge {
  struct ScrEdge *next, *prev;
  ScrVert *v1, *v2;
  short border;
  short flag;
  char _pad[4];
} ScrEdge;
 
typedef struct ScrAreaMap {
  /* ** NOTE: KEEP ORDER IN SYNC WITH LISTBASES IN bScreen! ** */
 
  ListBase vertbase;
  ListBase edgebase;
  ListBase areabase;
} ScrAreaMap;
 
typedef struct Panel_Runtime {
  /* Applied to Panel.ofsx, but saved separately so we can track changes between redraws. */
  int region_ofsx;
 
  char _pad[4];
 
  struct PointerRNA *custom_data_ptr;
 
  /* Pointer to the panel's block. Useful when changes to panel #uiBlocks
   * need some context from traversal of the panel "tree". */
  struct uiBlock *block;
} Panel_Runtime;
 
typedef struct Panel {
  struct Panel *next, *prev;
 
  struct PanelType *type;
  struct uiLayout *layout;
 
  char panelname[64];
  char drawname[64];
  int ofsx, ofsy;
  int sizex, sizey;
  int blocksizex, blocksizey;
  short labelofs;
  short flag, runtime_flag;
  char _pad[6];
  int sortorder;
  void *activedata;
  ListBase children;
 
  Panel_Runtime runtime;
} Panel;
 
typedef enum uiPanelDataExpansion {
  UI_PANEL_DATA_EXPAND_ROOT = (1 << 0),
  UI_SUBPANEL_DATA_EXPAND_1 = (1 << 1),
  UI_SUBPANEL_DATA_EXPAND_2 = (1 << 2),
  UI_SUBPANEL_DATA_EXPAND_3 = (1 << 3),
  UI_SUBPANEL_DATA_EXPAND_4 = (1 << 4),
  UI_SUBPANEL_DATA_EXPAND_5 = (1 << 5),
  UI_SUBPANEL_DATA_EXPAND_6 = (1 << 6),
  UI_SUBPANEL_DATA_EXPAND_7 = (1 << 7),
  UI_SUBPANEL_DATA_EXPAND_8 = (1 << 8),
  UI_SUBPANEL_DATA_EXPAND_9 = (1 << 9),
  UI_SUBPANEL_DATA_EXPAND_10 = (1 << 10),
  UI_SUBPANEL_DATA_EXPAND_11 = (1 << 11),
  UI_SUBPANEL_DATA_EXPAND_12 = (1 << 12),
  UI_SUBPANEL_DATA_EXPAND_13 = (1 << 13),
  UI_SUBPANEL_DATA_EXPAND_14 = (1 << 14),
  UI_SUBPANEL_DATA_EXPAND_15 = (1 << 15),
  UI_SUBPANEL_DATA_EXPAND_16 = (1 << 16),
} uiPanelDataExpansion;
 
/* region level tabs */
#
#
typedef struct PanelCategoryDyn {
  struct PanelCategoryDyn *next, *prev;
  char idname[64];
  rcti rect;
} PanelCategoryDyn;
 
/* region stack of active tabs */
typedef struct PanelCategoryStack {
  struct PanelCategoryStack *next, *prev;
  char idname[64];
} PanelCategoryStack;
 
/* uiList dynamic data... */
/* These two Lines with # tell makesdna this struct can be excluded. */
#
#
typedef struct uiListDyn {
  int height;
  int visual_height;
  int visual_height_min;
 
  int items_len;
  int items_shown;
 
  /* Those are temp data used during drag-resize with GRIP button
   * (they are in pixels, the meaningful data is the
   * difference between resize_prev and resize)...
   */
  int resize;
  int resize_prev;
 
  /* Filtering data. */
  int *items_filter_flags;
  int *items_filter_neworder;
} uiListDyn;
 
typedef struct uiList { /* some list UI data need to be saved in file */
  struct uiList *next, *prev;
 
  struct uiListType *type;
 
  char list_id[64];
 
  int layout_type;
  int flag;
 
  int list_scroll;
  int list_grip;
  int list_last_len;
  int list_last_activei;
 
  /* Filtering data. */
  char filter_byname[64];
  int filter_flag;
  int filter_sort_flag;
 
  /* Custom sub-classes properties. */
  IDProperty *properties;
 
  /* Dynamic data (runtime). */
  uiListDyn *dyn_data;
} uiList;
 
typedef struct TransformOrientation {
  struct TransformOrientation *next, *prev;
  char name[64];
  float mat[3][3];
  char _pad[4];
} TransformOrientation;
 
typedef struct uiPreview {
  struct uiPreview *next, *prev;
 
  char preview_id[64];
  short height;
  char _pad1[6];
} uiPreview;
 
typedef struct ScrGlobalAreaData {
  /* Global areas have a non-dynamic size. That means, changing the window
   * size doesn't affect their size at all. However, they can still be
   * 'collapsed', by changing this value. Ignores DPI (ED_area_global_size_y
   * and winx/winy don't) */
  short cur_fixed_height;
  /* For global areas, this is the min and max size they can use depending on
   * if they are 'collapsed' or not. */
  short size_min, size_max;
  short align;
 
  short flag;
  char _pad[2];
} ScrGlobalAreaData;
 
enum GlobalAreaFlag {
  GLOBAL_AREA_IS_HIDDEN = (1 << 0),
};
 
typedef enum GlobalAreaAlign {
  GLOBAL_AREA_ALIGN_TOP = 0,
  GLOBAL_AREA_ALIGN_BOTTOM = 1,
} GlobalAreaAlign;
 
typedef struct ScrArea_Runtime {
  struct bToolRef *tool;
  char is_tool_set;
  char _pad0[7];
} ScrArea_Runtime;
 
typedef struct ScrArea {
  struct ScrArea *next, *prev;
 
  ScrVert *v1, *v2, *v3, *v4;
  bScreen *full;
 
  rcti totrct;
 
  char spacetype;
  char butspacetype;
  short butspacetype_subtype;
 
  short winx, winy;
 
  char headertype DNA_DEPRECATED;
  char do_refresh;
  short flag;
  short region_active_win;
  char _pad[2];
 
  struct SpaceType *type;
 
  /* Non-NULL if this area is global. */
  ScrGlobalAreaData *global;
 
  /* A list of space links (editors) that were open in this area before. When
   * changing the editor type, we try to reuse old editor data from this list.
   * The first item is the active/visible one.
   */
  ListBase spacedata;
  /* NOTE: This region list is the one from the active/visible editor (first item in
   * spacedata list). Use SpaceLink.regionbase if it's inactive (but only then)!
   */
  ListBase regionbase;
  ListBase handlers;
 
  ListBase actionzones;
 
  ScrArea_Runtime runtime;
} ScrArea;
 
typedef struct ARegion_Runtime {
  /* Panel category to use between 'layout' and 'draw'. */
  const char *category;
 
  rcti visible_rect;
 
  /* The offset needed to not overlap with window scrollbars. Only used by HUD regions for now. */
  int offset_x, offset_y;
} ARegion_Runtime;
 
typedef struct ARegion {
  struct ARegion *next, *prev;
 
  View2D v2d;
  rcti winrct;
  rcti drawrct;
  short winx, winy;
 
  short visible;
  short regiontype;
  short alignment;
  short flag;
 
  short sizex, sizey;
 
  short do_draw;
  short do_draw_paintcursor;
  short overlap;
  short flagfullscreen;
 
  struct ARegionType *type;
 
  ListBase uiblocks;
  ListBase panels;
  ListBase panels_category_active;
  ListBase ui_lists;
  ListBase ui_previews;
  ListBase handlers;
  ListBase panels_category;
 
  struct wmGizmoMap *gizmo_map;
  struct wmTimer *regiontimer;
  struct wmDrawBuffer *draw_buffer;
 
  char *headerstr;
  void *regiondata;
 
  ARegion_Runtime runtime;
} ARegion;
 
enum {
  HEADER_NO_PULLDOWN = (1 << 0),
//  AREA_FLAG_UNUSED_1           = (1 << 1),
//  AREA_FLAG_UNUSED_2           = (1 << 2),
#ifdef DNA_DEPRECATED_ALLOW
  AREA_TEMP_INFO = (1 << 3), /* versioned to make slot reusable */
#endif
  AREA_FLAG_REGION_SIZE_UPDATE = (1 << 3),
  AREA_FLAG_ACTIVE_TOOL_UPDATE = (1 << 4),
  // AREA_FLAG_UNUSED_5 = (1 << 5),
 
  AREA_FLAG_UNUSED_6 = (1 << 6), /* cleared */
 
  AREA_FLAG_STACKED_FULLSCREEN = (1 << 7),
  AREA_FLAG_ACTIONZONES_UPDATE = (1 << 8),
};
 
#define AREAGRID 4
#define AREAMINX 32
#define HEADER_PADDING_Y 6
#define HEADERY (20 + HEADER_PADDING_Y)
 
enum {
  SCREEN_DEPRECATED = 1,
  SCREEN_COLLAPSE_STATUSBAR = 2,
};
 
enum {
  SCREENNORMAL = 0,
  SCREENMAXIMIZED = 1, /* one editor taking over the screen */
  SCREENFULL = 2,      /* one editor taking over the screen with no bare-minimum UI elements */
};
 
typedef enum eScreen_Redraws_Flag {
  TIME_REGION = (1 << 0),
  TIME_ALL_3D_WIN = (1 << 1),
  TIME_ALL_ANIM_WIN = (1 << 2),
  TIME_ALL_BUTS_WIN = (1 << 3),
  // TIME_WITH_SEQ_AUDIO    = (1 << 4), /* DEPRECATED */
  TIME_SEQ = (1 << 5),
  TIME_ALL_IMAGE_WIN = (1 << 6),
  // TIME_CONTINUE_PHYSICS  = (1 << 7), /* UNUSED */
  TIME_NODES = (1 << 8),
  TIME_CLIPS = (1 << 9),
 
  TIME_FOLLOW = (1 << 15),
} eScreen_Redraws_Flag;
 
enum {
  PNL_SELECT = (1 << 0),
  PNL_UNUSED_1 = (1 << 1), /* Cleared */
  PNL_CLOSED = (1 << 2),
  /* PNL_TABBED = (1 << 3), */  /*UNUSED*/
  /* PNL_OVERLAP = (1 << 4), */ /*UNUSED*/
  PNL_PIN = (1 << 5),
  PNL_POPOVER = (1 << 6),
  PNL_INSTANCED_LIST_ORDER_CHANGED = (1 << 7),
};
 
/* Fallback panel category (only for old scripts which need updating) */
#define PNL_CATEGORY_FALLBACK "Misc"
 
enum {
  UILST_LAYOUT_DEFAULT = 0,
  UILST_LAYOUT_COMPACT = 1,
  UILST_LAYOUT_GRID = 2,
};
 
enum {
  /* Scroll list to make active item visible. */
  UILST_SCROLL_TO_ACTIVE_ITEM = 1 << 0,
};
 
/* Value (in number of items) we have to go below minimum shown items to enable auto size. */
#define UI_LIST_AUTO_SIZE_THRESHOLD 1
 
/* uiList filter flags (dyn_data) */
/* WARNING! Those values are used by integer RNA too, which does not handle well values > INT_MAX.
 *          So please do not use 32nd bit here. */
enum {
  UILST_FLT_ITEM = 1 << 30, /* This item has passed the filter process successfully. */
};
 
enum {
  UILST_FLT_SHOW = 1 << 0,            /* Show filtering UI. */
  UILST_FLT_EXCLUDE = UILST_FLT_ITEM, /* Exclude filtered items, *must* use this same value. */
};
 
enum {
  /* Plain values (only one is valid at a time, once masked with UILST_FLT_SORT_MASK. */
  /* UILST_FLT_SORT_INDEX = 0, */ /* UNUSED */
  UILST_FLT_SORT_ALPHA = 1,
 
  /* Bitflags affecting behavior of any kind of sorting. */
  UILST_FLT_SORT_LOCK = 1u << 30,
  UILST_FLT_SORT_REVERSE = 1u << 31,
};
 
#define UILST_FLT_SORT_MASK (((unsigned int)(UILST_FLT_SORT_REVERSE | UILST_FLT_SORT_LOCK)) - 1)
 
/* regiontype, first two are the default set */
/* Do NOT change order, append on end. Types are hardcoded needed */
typedef enum eRegionType {
  RGN_TYPE_WINDOW = 0,
  RGN_TYPE_HEADER = 1,
  RGN_TYPE_CHANNELS = 2,
  RGN_TYPE_TEMPORARY = 3,
  RGN_TYPE_UI = 4,
  RGN_TYPE_TOOLS = 5,
  RGN_TYPE_TOOL_PROPS = 6,
  RGN_TYPE_PREVIEW = 7,
  RGN_TYPE_HUD = 8,
  /* Region to navigate the main region from (RGN_TYPE_WINDOW). */
  RGN_TYPE_NAV_BAR = 9,
  /* A place for buttons to trigger execution of something that was set up in other regions. */
  RGN_TYPE_EXECUTE = 10,
  RGN_TYPE_FOOTER = 11,
  RGN_TYPE_TOOL_HEADER = 12,
 
#define RGN_TYPE_LEN (RGN_TYPE_TOOL_HEADER + 1)
} eRegionType;
 
/* use for function args */
#define RGN_TYPE_ANY -1
 
/* Region supports panel tabs (categories). */
#define RGN_TYPE_HAS_CATEGORY_MASK (1 << RGN_TYPE_UI)
 
/* Check for any kind of header region. */
#define RGN_TYPE_IS_HEADER_ANY(regiontype) \
  (((1 << (regiontype)) & \
    ((1 << RGN_TYPE_HEADER) | 1 << (RGN_TYPE_TOOL_HEADER) | (1 << RGN_TYPE_FOOTER))) != 0)
 
enum {
  RGN_ALIGN_NONE = 0,
  RGN_ALIGN_TOP = 1,
  RGN_ALIGN_BOTTOM = 2,
  RGN_ALIGN_LEFT = 3,
  RGN_ALIGN_RIGHT = 4,
  RGN_ALIGN_HSPLIT = 5,
  RGN_ALIGN_VSPLIT = 6,
  RGN_ALIGN_FLOAT = 7,
  RGN_ALIGN_QSPLIT = 8,
  /* Maximum 15. */
 
  /* Flags start here. */
  RGN_SPLIT_PREV = 32,
};
 
#define RGN_ALIGN_ENUM_FROM_MASK(align) ((align) & ((1 << 4) - 1))
#define RGN_ALIGN_FLAG_FROM_MASK(align) ((align) & ~((1 << 4) - 1))
 
enum {
  RGN_FLAG_HIDDEN = (1 << 0),
  RGN_FLAG_TOO_SMALL = (1 << 1),
  RGN_FLAG_DYNAMIC_SIZE = (1 << 2),
  RGN_FLAG_TEMP_REGIONDATA = (1 << 3),
  RGN_FLAG_PREFSIZE_OR_HIDDEN = (1 << 4),
  RGN_FLAG_SIZE_CLAMP_X = (1 << 5),
  RGN_FLAG_SIZE_CLAMP_Y = (1 << 6),
  RGN_FLAG_HIDDEN_BY_USER = (1 << 7),
  RGN_FLAG_SEARCH_FILTER_ACTIVE = (1 << 8),
  RGN_FLAG_SEARCH_FILTER_UPDATE = (1 << 9),
};
 
enum {
  /* Region must be fully redrawn. */
  RGN_DRAW = 1,
  /* Redraw only part of region, for sculpting and painting to get smoother
   * stroke painting on heavy meshes. */
  RGN_DRAW_PARTIAL = 2,
  /* For outliner, to do faster redraw without rebuilding outliner tree.
   * For 3D viewport, to display a new progressive render sample without
   * while other buffers and overlays remain unchanged. */
  RGN_DRAW_NO_REBUILD = 4,
 
  /* Set while region is being drawn. */
  RGN_DRAWING = 8,
  /* For popups, to refresh UI layout along with drawing. */
  RGN_REFRESH_UI = 16,
 
  /* Only editor overlays (currently gizmos only!) should be redrawn. */
  RGN_DRAW_EDITOR_OVERLAYS = 32,
};
 
#ifdef __cplusplus
}
#endif