DNA_screen_types.h

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include "BLI_utildefines.h"
 
#include "DNA_asset_types.h"
#include "DNA_defs.h"
#include "DNA_listBase.h"
#include "DNA_vec_types.h"
#include "DNA_view2d_types.h"
 
#include "DNA_ID.h"
 
struct ARegion;
struct ARegionType;
struct PanelType;
struct PointerRNA;
struct Scene;
struct SpaceLink;
struct SpaceType;
struct uiBlock;
struct uiLayout;
struct uiList;
struct uiListType;
struct wmDrawBuffer;
struct wmTimer;
struct wmTooltipState;
struct Panel_Runtime;
#ifdef __cplusplus
namespace blender::bke {
struct ARegionRuntime;
struct FileHandlerType;
}  // namespace blender::bke
using ARegionRuntimeHandle = blender::bke::ARegionRuntime;
using FileHandlerTypeHandle = blender::bke::FileHandlerType;
#else
typedef struct ARegionRuntimeHandle ARegionRuntimeHandle;
typedef struct FileHandlerTypeHandle FileHandlerTypeHandle;
#endif
 
/* 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 {
#ifdef __cplusplus
  static constexpr ID_Type id_type = ID_SCR;
#endif
 
  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;
  /* End variables that must be in sync with #ScrAreaMap. */

  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 LayoutPanelState {
  struct LayoutPanelState *next, *prev;
  char *idname;
  uint8_t flag;
  char _pad[3];
  uint32_t last_used;
} LayoutPanelState;
 
enum LayoutPanelStateFlag {
  LAYOUT_PANEL_STATE_FLAG_OPEN = (1 << 0),
};

typedef struct Panel {
  struct Panel *next, *prev;

  struct PanelType *type;
  struct uiLayout *layout;
 
  char panelname[/*BKE_ST_MAXNAME*/ 64];
  char *drawname;
  int ofsx, ofsy;
  int sizex, sizey;
  int blocksizex, blocksizey;
  short labelofs;
  short flag, runtime_flag;
  char _pad[6];
  int sortorder;
  void *activedata;
  ListBase children;

  ListBase layout_panel_states;
  uint32_t layout_panel_states_clock;
  char _pad2[4];
 
  struct 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),
} uiPanelDataExpansion;

 
/* region level tabs */
#
#
typedef struct PanelCategoryDyn {
  struct PanelCategoryDyn *next, *prev;
  char idname[64];
  rcti rect;
} PanelCategoryDyn;

typedef struct PanelCategoryStack {
  struct PanelCategoryStack *next, *prev;
  char idname[64];
} PanelCategoryStack;
 
typedef void (*uiListFreeRuntimeDataFunc)(struct uiList *ui_list);
 
/* uiList dynamic data... */
/* These two lines with # tell `makesdna` this struct can be excluded. */
#
#
typedef struct uiListDyn {
  uiListFreeRuntimeDataFunc free_runtime_data_fn;

  int height;
  int visual_height;
  int visual_height_min;

  int columns;

  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;

  void *customdata;
 
  /* Filtering data. */
  int *items_filter_flags;
  int *items_filter_neworder;
 
  struct wmOperatorType *custom_drag_optype;
  struct PointerRNA *custom_drag_opptr;
  struct wmOperatorType *custom_activate_optype;
  struct PointerRNA *custom_activate_opptr;
} uiListDyn;
 
typedef struct uiList { /* some list UI data need to be saved in file */
  struct uiList *next, *prev;

  struct uiListType *type;
 
  char list_id[/*UI_MAX_NAME_STR*/ 128];

  int layout_type;
  int flag;
 
  int list_scroll;
  int list_grip;
  int list_last_len;
  int list_last_activei;
 
  /* Filtering data. */
  char filter_byname[/*UI_MAX_NAME_STR*/ 128];
  int filter_flag;
  int filter_sort_flag;

  IDProperty *properties;

  uiListDyn *dyn_data;
} uiList;

typedef struct uiViewState {
  int custom_height;
  int scroll_offset;
} uiViewState;

typedef struct uiViewStateLink {
  struct uiViewStateLink *next, *prev;
 
  char idname[/*BKE_ST_MAXNAME*/ 64];
 
  uiViewState state;
} uiViewStateLink;
 
typedef struct TransformOrientation {
  struct TransformOrientation *next, *prev;
  char name[/*MAX_NAME*/ 64];
  float mat[3][3];
  char _pad[4];
} TransformOrientation;

typedef struct uiPreview {
  struct uiPreview *next, *prev;
 
  char preview_id[/*BKE_ST_MAXNAME*/ 64];
  short height;
 
  /* Unset on file read. */
  short tag; /* #uiPreviewTag */

  unsigned int id_session_uid;
} uiPreview;
 
typedef enum uiPreviewTag {
  UI_PREVIEW_TAG_DIRTY = (1 << 0),
} uiPreviewTag;
 
typedef struct ScrGlobalAreaData {
  short cur_fixed_height;
  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 {
  DNA_DEFINE_CXX_METHODS(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;

  ScrGlobalAreaData *global;

  ListBase spacedata;
  ListBase regionbase;
  ListBase handlers;

  ListBase actionzones;
 
  ScrArea_Runtime runtime;
} ScrArea;
 
typedef struct ARegion {
  struct ARegion *next, *prev;

  View2D v2d;
  rcti winrct;
  short winx, winy;
  int category_scroll;

  short regiontype;
  short alignment;
  short flag;

  short sizex, sizey;

  short overlap;
  short flagfullscreen;
 
  char _pad[2];

  ListBase panels;
  ListBase panels_category_active;
  ListBase ui_lists;
  ListBase ui_previews;
  ListBase view_states; /* #uiViewStateLink */

  void *regiondata;
 
  ARegionRuntimeHandle *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),
  AREA_FLAG_OFFSCREEN = (1 << 9),
};
 
#define AREAGRID 1
#define AREAMINX 29
#define HEADER_PADDING_Y 6
#define HEADERY (20 + HEADER_PADDING_Y)

enum {
  SCREEN_DEPRECATED = 1,
  SCREEN_COLLAPSE_STATUSBAR = 2,
};

enum {
  SCREENNORMAL = 0,
  SCREENMAXIMIZED = 1,
  SCREENFULL = 2,
};

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_SPREADSHEETS = (1 << 10),
 
  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),
};

#define PNL_CATEGORY_FALLBACK "Misc"

enum {
  UILST_LAYOUT_DEFAULT = 0,
  UILST_LAYOUT_COMPACT = 1,
  UILST_LAYOUT_GRID = 2,
  UILST_LAYOUT_BIG_PREVIEW_GRID = 3,
};

enum {
  UILST_SCROLL_TO_ACTIVE_ITEM = 1 << 0,
};

#define UI_LIST_AUTO_SIZE_THRESHOLD 1

enum {
  /* Don't use (1 << 0) to (1 << 15) here! See warning above. */
 
  /* Filtering returned #UI_LIST_ITEM_NEVER_SHOW. */
  UILST_FLT_ITEM_NEVER_SHOW = (1 << 16),
  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)

typedef enum eRegion_Type {
  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,
  /* Region type used exclusively by internal code and add-ons to register draw callbacks to the XR
   * context (surface, mirror view). Does not represent any real region. */
  RGN_TYPE_XR = 13,
  RGN_TYPE_ASSET_SHELF = 14,
  RGN_TYPE_ASSET_SHELF_HEADER = 15,
 
#define RGN_TYPE_NUM (RGN_TYPE_ASSET_SHELF_HEADER + 1)
} eRegion_Type;

#define RGN_TYPE_ANY -1

#define RGN_TYPE_HAS_CATEGORY_MASK (1 << RGN_TYPE_UI)

#define RGN_TYPE_IS_HEADER_ANY(regiontype) \
  (((1 << (regiontype)) & ((1 << RGN_TYPE_HEADER) | 1 << (RGN_TYPE_TOOL_HEADER) | \
                           (1 << RGN_TYPE_FOOTER) | (1 << RGN_TYPE_ASSET_SHELF_HEADER))) != 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 = 1 << 5,
  RGN_SPLIT_SCALE_PREV = 1 << 6,
  RGN_ALIGN_HIDE_WITH_PREV = 1 << 7,
};

#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_NO_USER_RESIZE = (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),
  RGN_FLAG_POLL_FAILED = (1 << 10),
  RGN_FLAG_RESIZE_RESPECT_BUTTON_SECTIONS = (1 << 11),
};

enum {
  RGN_DRAW = 1,
  RGN_DRAW_PARTIAL = 2,
  RGN_DRAW_NO_REBUILD = 4,

  RGN_DRAWING = 8,
  RGN_REFRESH_UI = 16,

  RGN_DRAW_EDITOR_OVERLAYS = 32,
};
 
typedef struct AssetShelfSettings {
  AssetLibraryReference asset_library_reference;
 
  ListBase enabled_catalog_paths; /* #AssetCatalogPathLink */
  const char *active_catalog_path;

  char search_string[64];
 
  short preview_size;
  short display_flag; /* #AssetShelfSettings_DisplayFlag */
  char _pad1[4];
 
#ifdef __cplusplus
  /* Zero initializes. */
  AssetShelfSettings();
  /* Proper deep copy. */
  AssetShelfSettings(const AssetShelfSettings &other);
  AssetShelfSettings &operator=(const AssetShelfSettings &other);
  ~AssetShelfSettings();
#endif
} AssetShelfSettings;
 
typedef struct AssetShelf {
  DNA_DEFINE_CXX_METHODS(AssetShelf)
 
  struct AssetShelf *next, *prev;

  char idname[/*MAX_NAME*/ 64];
  struct AssetShelfType *type;
 
  AssetShelfSettings settings;

  short preferred_row_count;
  short instance_flag;
  char _pad[4];
} AssetShelf;

typedef struct RegionAssetShelf {
  ListBase shelves;
  AssetShelf *active_shelf; /* Non-owning. */
#ifdef __cplusplus
  static RegionAssetShelf *get_from_asset_shelf_region(const ARegion &region);
  static RegionAssetShelf *ensure_from_asset_shelf_region(ARegion &region);
#endif
} RegionAssetShelf;
 
/* #AssetShelfSettings.display_flag */
typedef enum AssetShelfSettings_DisplayFlag {
  ASSETSHELF_SHOW_NAMES = (1 << 0),
} AssetShelfSettings_DisplayFlag;
ENUM_OPERATORS(AssetShelfSettings_DisplayFlag, ASSETSHELF_SHOW_NAMES);
 
/* #AssetShelfSettings.instance_flag */
typedef enum AssetShelf_InstanceFlag {
  ASSETSHELF_REGION_IS_HIDDEN = (1 << 0),
} AssetShelf_InstanceFlag;
ENUM_OPERATORS(AssetShelf_InstanceFlag, ASSETSHELF_REGION_IS_HIDDEN);
 
typedef struct FileHandler {
  DNA_DEFINE_CXX_METHODS(FileHandler)
  FileHandlerTypeHandle *type;
} FileHandler;