BKE_screen.hh

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 <memory>
#include <string>
 
#include "BLI_compiler_attrs.h"
#include "BLI_math_vector_types.hh"
#include "BLI_vector.hh"
 
#include "RNA_types.hh"
 
#include "BKE_context.hh"
 
namespace blender::bke::id {
class IDRemapper;
}
 
namespace blender::asset_system {
class AssetRepresentation;
}
 
struct ARegion;
struct AssetShelfType;
struct BlendDataReader;
struct BlendLibReader;
struct BlendWriter;
struct Header;
struct ID;
struct LayoutPanelState;
struct LibraryForeachIDData;
struct ListBase;
struct Menu;
struct Panel;
struct Scene;
struct ScrArea;
struct ScrAreaMap;
struct ScrEdge;
struct ScrVert;
struct SpaceType;
struct View3D;
struct View3DShading;
struct WorkSpace;
struct bContext;
struct bScreen;
struct uiBlock;
struct uiLayout;
struct uiList;
struct wmGizmoMap;
struct wmKeyConfig;
struct wmMsgBus;
struct wmNotifier;
struct wmWindow;
struct wmWindowManager;
 
/* spacetype has everything stored to get an editor working, it gets initialized via
 * #ED_spacetypes_init() in `editors/space_api/spacetypes.cc` */
/* an editor in Blender is a combined ScrArea + SpaceType + SpaceData */
 
#define BKE_ST_MAXNAME 64
 
struct wmSpaceTypeListenerParams {
  wmWindow *window;
  ScrArea *area;
  const wmNotifier *notifier;
  const Scene *scene;
};
 
struct SpaceType {
  char name[BKE_ST_MAXNAME]; /* for menus */
  int spaceid;               /* unique space identifier */
  int iconid;                /* icon lookup for menus */
 
  /* Initial allocation, after this WM will call init() too. Some editors need
   * area and scene data (e.g. frame range) to set their initial scrolling. */
  SpaceLink *(*create)(const ScrArea *area, const Scene *scene);
  /* not free spacelink itself */
  void (*free)(SpaceLink *sl);
 
  /* init is to cope with file load, screen (size) changes, check handlers */
  void (*init)(wmWindowManager *wm, ScrArea *area);
  /* exit is called when the area is hidden or removed */
  void (*exit)(wmWindowManager *wm, ScrArea *area);
  /* Listeners can react to bContext changes */
  void (*listener)(const wmSpaceTypeListenerParams *params);
 
  /* called when the mouse moves out of the area */
  void (*deactivate)(ScrArea *area);
 
  void (*refresh)(const bContext *C, ScrArea *area);
 
  /* after a spacedata copy, an init should result in exact same situation */
  SpaceLink *(*duplicate)(SpaceLink *sl);
 
  /* register operator types on startup */
  void (*operatortypes)();
  /* add default items to WM keymap */
  void (*keymap)(wmKeyConfig *keyconf);
  /* on startup, define dropboxes for spacetype+regions */
  void (*dropboxes)();
 
  /* initialize gizmo-map-types and gizmo-group-types with the region */
  void (*gizmos)();
 
  /* return context data */
  bContextDataCallback context;
 
  /* Used when we want to replace an ID by another (or NULL). */
  void (*id_remap)(ScrArea *area, SpaceLink *sl, const blender::bke::id::IDRemapper &mappings);
 
  void (*foreach_id)(SpaceLink *space_link, LibraryForeachIDData *data);
 
  int (*space_subtype_get)(ScrArea *area);
  void (*space_subtype_set)(ScrArea *area, int value);
  void (*space_subtype_item_extend)(bContext *C, EnumPropertyItem **item, int *totitem);
 
  /* Return a custom name, based on subtype or other reason. */
  blender::StringRefNull (*space_name_get)(const ScrArea *area);
  /* Return a custom icon, based on subtype or other reason. */
  int (*space_icon_get)(const ScrArea *area);
 
  void (*blend_read_data)(BlendDataReader *reader, SpaceLink *space_link);
 
  void (*blend_read_after_liblink)(BlendLibReader *reader, ID *parent_id, SpaceLink *space_link);
 
  void (*blend_write)(BlendWriter *writer, SpaceLink *space_link);
 
  /* region type definitions */
  ListBase regiontypes;
 
  /* read and write... */
 
  int keymapflag;
 
  ~SpaceType();
};
 
/* region types are also defined using spacetypes_init, via a callback */
 
struct wmRegionListenerParams {
  wmWindow *window;
  ScrArea *area; /* Can be NULL when the region is not part of an area. */
  ARegion *region;
  const wmNotifier *notifier;
  const Scene *scene;
};
 
struct wmRegionMessageSubscribeParams {
  const bContext *context;
  wmMsgBus *message_bus;
  WorkSpace *workspace;
  Scene *scene;
  bScreen *screen;
  ScrArea *area;
  ARegion *region;
};
 
struct RegionPollParams {
  const bScreen *screen;
  const ScrArea *area;
  const ARegion *region;
 
  const bContext *context;
};
 
struct ARegionType {
  ARegionType *next, *prev;
 
  int regionid; /* unique identifier within this space, defines RGN_TYPE_xxxx */
 
  /* add handlers, stuff you only do once or on area/region type/size changes */
  void (*init)(wmWindowManager *wm, ARegion *region);
  /* exit is called when the region is hidden or removed */
  void (*exit)(wmWindowManager *wm, ARegion *region);
  bool (*poll)(const RegionPollParams *params);
  /* draw entirely, view changes should be handled here */
  void (*draw)(const bContext *C, ARegion *region);
  void (*draw_overlay)(const bContext *C, ARegion *region);
  /* optional, compute button layout before drawing for dynamic size */
  void (*layout)(const bContext *C, ARegion *region);
  /* snap the size of the region (can be NULL for no snapping). */
  int (*snap_size)(const ARegion *region, int size, int axis);
  /* contextual changes should be handled here */
  void (*listener)(const wmRegionListenerParams *params);
  /* Optional callback to generate subscriptions. */
  void (*message_subscribe)(const wmRegionMessageSubscribeParams *params);
 
  void (*free)(ARegion *);
 
  /* split region, copy data optionally */
  void *(*duplicate)(void *poin);
 
  /* register operator types on startup */
  void (*operatortypes)();
  /* add items to keymap */
  void (*keymap)(wmKeyConfig *keyconf);
  /* allows default cursor per region */
  void (*cursor)(wmWindow *win, ScrArea *area, ARegion *region);
 
  /* return context data */
  bContextDataCallback context;
 
  void (*on_poll_success)(const bContext *C, ARegion *region);
 
  void (*on_user_resize)(const ARegion *region);
  /* Is called whenever the current visible View2D's region changes.
   *
   * Used from user code such as view navigation/zoom operators to inform region about changes.
   * The goal is to support zoom-to-fit features which gets disabled when manual navigation is
   * performed.
   *
   * This callback is not called on indirect changes of the current viewport (which could happen
   * when the `v2d->tot is changed and `cur` is adopted accordingly). */
  void (*on_view2d_changed)(const bContext *C, ARegion *region);
 
  /* custom drawing callbacks */
  ListBase drawcalls;
 
  /* panels type definitions */
  ListBase paneltypes;
 
  /* header type definitions */
  ListBase headertypes;
 
  /* hardcoded constraints, smaller than these values region is not visible */
  int minsizex, minsizey;
  /* when new region opens (region prefsizex/y are zero then */
  int prefsizex, prefsizey;
  /* default keymaps to add */
  int keymapflag;
  /* return without drawing.
   * lock is set by region definition, and copied to do_lock by render. can become flag. */
  short do_lock, lock;
  bool clip_gizmo_events_by_ui;
  /* call cursor function on each move event */
  short event_cursor;
};
 
/* panel types */
 
struct PanelType {
  PanelType *next, *prev;
 
  char idname[BKE_ST_MAXNAME]; /* unique name */
  char label[BKE_ST_MAXNAME];  /* for panel header */
  const char *description;     /* for panel tooltip */
  char translation_context[BKE_ST_MAXNAME];
  char context[BKE_ST_MAXNAME];   /* for buttons window */
  char category[BKE_ST_MAXNAME];  /* for category tabs */
  char owner_id[128];             /* for work-spaces to selectively show. */
  char parent_id[BKE_ST_MAXNAME]; /* parent idname for sub-panels */
  char active_property[BKE_ST_MAXNAME];
  char pin_to_last_property[BKE_ST_MAXNAME];
  short space_type;
  short region_type;
  /* For popovers, 0 for default. */
  int ui_units_x;
  blender::float2 offset_units_xy;
  int order;
 
  int flag;
 
  /* verify if the panel should draw or not */
  bool (*poll)(const bContext *C, PanelType *pt);
  /* draw header (optional) */
  void (*draw_header)(const bContext *C, Panel *panel);
  /* draw header preset (optional) */
  void (*draw_header_preset)(const bContext *C, Panel *panel);
  /* draw entirely, view changes should be handled here */
  void (*draw)(const bContext *C, Panel *panel);
  void (*listener)(const wmRegionListenerParams *params);
 
  /* For instanced panels corresponding to a list: */
 
  void (*reorder)(bContext *C, Panel *pa, int new_index);
  short (*get_list_data_expand_flag)(const bContext *C, Panel *pa);
  void (*set_list_data_expand_flag)(const bContext *C, Panel *pa, short expand_flag);
 
  /* sub panels */
  PanelType *parent;
  ListBase children;
 
  /* RNA integration */
  ExtensionRNA rna_ext;
};
 
/* #PanelType.flag */
enum {
  PANEL_TYPE_DEFAULT_CLOSED = (1 << 0),
  PANEL_TYPE_NO_HEADER = (1 << 1),
  PANEL_TYPE_HEADER_EXPAND = (1 << 2),
  PANEL_TYPE_LAYOUT_VERT_BAR = (1 << 3),
  PANEL_TYPE_INSTANCED = (1 << 4),
  PANEL_TYPE_NO_SEARCH = (1 << 7),
};
 
struct LayoutPanelHeader {
  float start_y;
  float end_y;
  PointerRNA open_owner_ptr;
  std::string open_prop_name;
};
 
struct LayoutPanelBody {
  float start_y;
  float end_y;
};
 
struct LayoutPanels {
  blender::Vector<LayoutPanelHeader> headers;
  blender::Vector<LayoutPanelBody> bodies;
 
  void clear()
  {
    this->headers.clear();
    this->bodies.clear();
  }
};
 
struct Panel_Runtime {
  /* Applied to Panel.ofsx, but saved separately so we can track changes between redraws. */
  int region_ofsx = 0;
 
  PointerRNA *custom_data_ptr = nullptr;
 
  /* Pointer to the panel's block. Useful when changes to panel #uiBlocks
   * need some context from traversal of the panel "tree". */
  uiBlock *block = nullptr;
 
  /* Non-owning pointer. The context is stored in the block. */
  bContextStore *context = nullptr;
 
  LayoutPanels layout_panels;
};
 
/* #uiList types. */
 
using uiListDrawItemFunc = void (*)(uiList *ui_list,
                                    const bContext *C,
                                    uiLayout *layout,
                                    PointerRNA *dataptr,
                                    PointerRNA *itemptr,
                                    int icon,
                                    PointerRNA *active_dataptr,
                                    const char *active_propname,
                                    int index,
                                    int flt_flag);
 
/* Draw the filtering part of an uiList */
using uiListDrawFilterFunc = void (*)(uiList *ui_list, const bContext *C, uiLayout *layout);
 
/* Filter items of an uiList */
using uiListFilterItemsFunc = void (*)(uiList *ui_list,
                                       const bContext *C,
                                       PointerRNA *,
                                       const char *propname);
 
/* Listen to notifiers. Only for lists defined in C. */
using uiListListener = void (*)(uiList *ui_list, wmRegionListenerParams *params);
 
struct uiListType {
  uiListType *next, *prev;
 
  char idname[BKE_ST_MAXNAME]; /* unique name */
 
  uiListDrawItemFunc draw_item;
  uiListDrawFilterFunc draw_filter;
  uiListFilterItemsFunc filter_items;
 
  /* For lists defined in C only. */
  uiListListener listener;
 
  /* RNA integration */
  ExtensionRNA rna_ext;
};
 
/* header types */
 
struct HeaderType {
  HeaderType *next, *prev;
 
  char idname[BKE_ST_MAXNAME]; /* unique name */
  int space_type;
  int region_type;
 
  bool (*poll)(const bContext *C, HeaderType *ht);
  /* draw entirely, view changes should be handled here */
  void (*draw)(const bContext *C, Header *header);
 
  /* RNA integration */
  ExtensionRNA rna_ext;
};
 
struct Header {
  HeaderType *type; /* runtime */
  uiLayout *layout; /* runtime for drawing */
};
 
/* menu types */
 
enum class MenuTypeFlag {
  ContextDependent = (1 << 0),
  SearchOnKeyPress = (1 << 1),
};
ENUM_OPERATORS(MenuTypeFlag, MenuTypeFlag::ContextDependent)
 
struct MenuType {
  MenuType *next, *prev;
 
  char idname[BKE_ST_MAXNAME]; /* unique name */
  char label[BKE_ST_MAXNAME];  /* for button text */
  char translation_context[BKE_ST_MAXNAME];
  char owner_id[128]; /* optional, see: #wmOwnerID */
  const char *description;
 
  /* verify if the menu should draw or not */
  bool (*poll)(const bContext *C, MenuType *mt);
  /* draw entirely, view changes should be handled here */
  void (*draw)(const bContext *C, Menu *menu);
  void (*listener)(const wmRegionListenerParams *params);
 
  MenuTypeFlag flag;
 
  /* RNA integration */
  ExtensionRNA rna_ext;
};
 
struct Menu {
  MenuType *type;   /* runtime */
  uiLayout *layout; /* runtime for drawing */
};
 
/* asset shelf types */
 
/* #AssetShelfType.flag */
enum AssetShelfTypeFlag {
  ASSET_SHELF_TYPE_FLAG_NO_ASSET_DRAG = (1 << 0),
  ASSET_SHELF_TYPE_FLAG_DEFAULT_VISIBLE = (1 << 1),
  ASSET_SHELF_TYPE_FLAG_STORE_CATALOGS_IN_PREFS = (1 << 2),
 
  ASSET_SHELF_TYPE_FLAG_MAX
};
ENUM_OPERATORS(AssetShelfTypeFlag, ASSET_SHELF_TYPE_FLAG_MAX);
 
#define ASSET_SHELF_PREVIEW_SIZE_DEFAULT 64
 
struct AssetShelfType {
  char idname[BKE_ST_MAXNAME]; /* unique name */
 
  int space_type;
 
  std::string activate_operator;
 
  AssetShelfTypeFlag flag;
 
  short default_preview_size;
 
  bool (*poll)(const bContext *C, const AssetShelfType *shelf_type);
 
  bool (*asset_poll)(const AssetShelfType *shelf_type,
                     const blender::asset_system::AssetRepresentation *asset);
 
  void (*draw_context_menu)(const bContext *C,
                            const AssetShelfType *shelf_type,
                            const blender::asset_system::AssetRepresentation *asset,
                            uiLayout *layout);
 
  const AssetWeakReference *(*get_active_asset)(const AssetShelfType *shelf_type);
 
  /* RNA integration */
  ExtensionRNA rna_ext;
};
 
/* Space-types. */
 
SpaceType *BKE_spacetype_from_id(int spaceid);
ARegionType *BKE_regiontype_from_id(const SpaceType *st, int regionid);
blender::Span<std::unique_ptr<SpaceType>> BKE_spacetypes_list();
void BKE_spacetype_register(std::unique_ptr<SpaceType> st);
bool BKE_spacetype_exists(int spaceid);
void BKE_spacetypes_free(); /* only for quitting blender */
 
/* Space-data. */
 
void BKE_spacedata_freelist(ListBase *lb);
void BKE_spacedata_copylist(ListBase *lb_dst, ListBase *lb_src);
 
void BKE_spacedata_draw_locks(bool set);
 
ARegion *BKE_spacedata_find_region_type(const SpaceLink *slink,
                                        const ScrArea *area,
                                        int region_type) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
 
void BKE_spacedata_callback_id_remap_set(
    void (*func)(ScrArea *area, SpaceLink *sl, ID *old_id, ID *new_id));
void BKE_spacedata_id_unref(ScrArea *area, SpaceLink *sl, ID *id);
 
/* Area/regions. */
 
ARegion *BKE_area_region_copy(const SpaceType *st, const ARegion *region);
void BKE_area_region_free(SpaceType *st, ARegion *region);
void BKE_area_region_panels_free(ListBase *panels);
Panel *BKE_panel_new(PanelType *panel_type);
void BKE_panel_free(Panel *panel);
void BKE_screen_area_free(ScrArea *area);
void BKE_region_callback_free_gizmomap_set(void (*callback)(wmGizmoMap *));
void BKE_region_callback_refresh_tag_gizmomap_set(void (*callback)(wmGizmoMap *));
 
LayoutPanelState *BKE_panel_layout_panel_state_ensure(Panel *panel,
                                                      const char *idname,
                                                      bool default_closed);
 
ARegion *BKE_region_find_in_listbase_by_type(const ListBase *regionbase, const int region_type);
ARegion *BKE_area_find_region_type(const ScrArea *area, int region_type);
ARegion *BKE_area_find_region_active_win(const ScrArea *area);
ARegion *BKE_area_find_region_xy(const ScrArea *area, int regiontype, const int xy[2])
    ATTR_NONNULL(3);
ARegion *BKE_screen_find_region_xy(const bScreen *screen,
                                   int regiontype,
                                   const int xy[2]) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1, 3);
 
ARegion *BKE_screen_find_main_region_at_xy(const bScreen *screen, int space_type, const int xy[2])
    ATTR_NONNULL(1, 3);
ScrArea *BKE_screen_find_area_from_space(const bScreen *screen,
                                         const SpaceLink *sl) ATTR_WARN_UNUSED_RESULT
    ATTR_NONNULL(1, 2);
std::optional<std::string> BKE_screen_path_from_screen_to_space(const PointerRNA *ptr);
ScrArea *BKE_screen_find_big_area(const bScreen *screen, int spacetype, short min);
ScrArea *BKE_screen_area_map_find_area_xy(const ScrAreaMap *areamap,
                                          int spacetype,
                                          const int xy[2]) ATTR_NONNULL(1, 3);
ScrArea *BKE_screen_find_area_xy(const bScreen *screen, int spacetype, const int xy[2])
    ATTR_NONNULL(1, 3);
 
void BKE_screen_gizmo_tag_refresh(bScreen *screen);
 
void BKE_screen_runtime_refresh_for_blendfile(bScreen *screen);
 
void BKE_screen_view3d_sync(View3D *v3d, Scene *scene);
void BKE_screen_view3d_scene_sync(bScreen *screen, Scene *scene);
bool BKE_screen_is_fullscreen_area(const bScreen *screen) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
bool BKE_screen_is_used(const bScreen *screen) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL();
 
/* Zoom factor conversion. */
 
float BKE_screen_view3d_zoom_to_fac(float camzoom);
float BKE_screen_view3d_zoom_from_fac(float zoomfac);
 
void BKE_screen_view3d_shading_init(View3DShading *shading);
 
/* Screen. */
 
void BKE_screen_foreach_id_screen_area(LibraryForeachIDData *data, ScrArea *area);
 
void BKE_screen_free_data(bScreen *screen);
void BKE_screen_area_map_free(ScrAreaMap *area_map) ATTR_NONNULL();
 
ScrEdge *BKE_screen_find_edge(const bScreen *screen, ScrVert *v1, ScrVert *v2);
void BKE_screen_sort_scrvert(ScrVert **v1, ScrVert **v2);
void BKE_screen_remove_double_scrverts(bScreen *screen);
void BKE_screen_remove_double_scredges(bScreen *screen);
void BKE_screen_remove_unused_scredges(bScreen *screen);
void BKE_screen_remove_unused_scrverts(bScreen *screen);
 
void BKE_screen_header_alignment_reset(bScreen *screen);
 
/* .blend file I/O */
 
void BKE_screen_view3d_shading_blend_write(BlendWriter *writer, View3DShading *shading);
void BKE_screen_view3d_shading_blend_read_data(BlendDataReader *reader, View3DShading *shading);
 
void BKE_screen_area_map_blend_write(BlendWriter *writer, ScrAreaMap *area_map);
bool BKE_screen_area_map_blend_read_data(BlendDataReader *reader, ScrAreaMap *area_map);
void BKE_screen_view3d_do_versions_250(View3D *v3d, ListBase *regions);
 
void BKE_screen_area_blend_read_after_liblink(BlendLibReader *reader,
                                              ID *parent_id,
                                              ScrArea *area);
bool BKE_screen_blend_read_data(BlendDataReader *reader, bScreen *screen);