BKE_screen.hh File Reference

#include <memory>
#include <string>
#include "BLI_compiler_attrs.h"
#include "BLI_map.hh"
#include "BLI_math_vector_types.hh"
#include "BLI_string_ref.hh"
#include "BLI_vector.hh"
#include "DNA_vec_types.h"
#include "RNA_types.hh"
#include "BKE_context.hh"

Go to the source code of this file.

Classes
struct	wmSpaceTypeListenerParams
struct	SpaceType
struct	wmRegionListenerParams
struct	wmRegionMessageSubscribeParams
struct	RegionPollParams
struct	ARegionType
struct	PanelType
struct	LayoutPanelHeader
struct	LayoutPanelBody
struct	LayoutPanels
struct	Panel_Runtime
struct	blender::bke::ARegionRuntime
struct	uiListType
struct	HeaderType
struct	Header
struct	MenuType
struct	Menu
struct	AssetShelfType

Namespaces
namespace	blender
namespace	blender::bke
namespace	blender::bke::id
namespace	blender::asset_system

Macros
#define	BKE_ST_MAXNAME   64
#define	ASSET_SHELF_PREVIEW_SIZE_DEFAULT   64

Typedefs
using	uiListDrawItemFunc
using	uiListDrawFilterFunc = void (*)(uiList *ui_list, const bContext *C, uiLayout *layout)
using	uiListFilterItemsFunc
using	uiListListener = void (*)(uiList *ui_list, wmRegionListenerParams *params)

Enumerations
enum	ARegionDrawLockFlags { REGION_DRAW_LOCK_NONE = 0 , REGION_DRAW_LOCK_RENDER = (1 << 0) , REGION_DRAW_LOCK_BAKING = (1 << 1) , REGION_DRAW_LOCK_ALL = (REGION_DRAW_LOCK_RENDER | REGION_DRAW_LOCK_BAKING) }
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) }
enum class	MenuTypeFlag { ContextDependent = (1 << 0) , SearchOnKeyPress = (1 << 1) }
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 }

Functions
	ENUM_OPERATORS (AssetShelfTypeFlag, ASSET_SHELF_TYPE_FLAG_MAX)
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 ()
void	BKE_spacedata_freelist (ListBase *lb)
void	BKE_spacedata_copylist (ListBase *lb_dst, ListBase *lb_src)
void	BKE_spacedata_draw_locks (ARegionDrawLockFlags lock_flags)
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)
ARegion *	BKE_area_region_copy (const SpaceType *st, const ARegion *region)
ARegion *	BKE_area_region_new ()
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, blender::StringRef 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_type (const bScreen *screen, int region_type) ATTR_NONNULL(1)
ARegion *	BKE_screen_find_region_xy (const bScreen *screen, int regiontype, const int xy[2]) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1
ARegion ARegion *	BKE_screen_find_main_region_at_xy (const bScreen *screen, int space_type, const int xy[2]) ATTR_NONNULL(1
ARegion ARegion ScrArea *	BKE_screen_find_area_from_space (const bScreen *screen, const SpaceLink *sl) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1
ARegion ARegion ScrArea 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
ScrArea ScrArea *	BKE_screen_find_area_xy (const bScreen *screen, int spacetype, const int xy[2]) ATTR_NONNULL(1
ScrArea ScrArea 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()
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)
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)
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)

Macro Definition Documentation

ASSET_SHELF_PREVIEW_SIZE_DEFAULT

#define ASSET_SHELF_PREVIEW_SIZE_DEFAULT   64

Definition at line 649 of file BKE_screen.hh.

Referenced by blender::ed::asset::shelf::asset_shelf_default_tile_height(), blender::ed::asset::shelf::create_shelf_from_type(), and blender::ed::asset::shelf::get_shelf_for_popup().

BKE_ST_MAXNAME

#define BKE_ST_MAXNAME   64

Definition at line 72 of file BKE_screen.hh.

Referenced by BKE_shaderfxType_panel_id(), bone_constraint_panel_id(), ed_panel_draw(), FILE_OT_unpack_item(), blender::ed::spreadsheet::filter_panel_id_fn(), graph_fmodifier_panel_id(), nla_fmodifier_panel_id(), object_constraint_panel_id(), rna_def_operator_common(), wm_call_menu_exec(), wm_call_menu_get_name(), wm_call_panel_exec(), wm_call_panel_get_name(), wm_call_pie_menu_exec(), wm_call_pie_menu_invoke(), WM_OT_call_menu(), WM_OT_call_menu_pie(), and WM_OT_call_panel().

Typedef Documentation

uiListDrawFilterFunc

using uiListDrawFilterFunc = void (*)(uiList *ui_list, const bContext *C, uiLayout *layout)

Draw the filtering part of an uiList.

Definition at line 535 of file BKE_screen.hh.

uiListDrawItemFunc

using uiListDrawItemFunc

Initial value:

 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 an item in the ui_list.

Definition at line 523 of file BKE_screen.hh.

uiListFilterItemsFunc

using uiListFilterItemsFunc

Initial value:

 void (*)(uiList *ui_list,
                                       const bContext *C,
                                       PointerRNA *,
                                       const char *propname)

Filter items of an uiList.

Definition at line 538 of file BKE_screen.hh.

uiListListener

using uiListListener = void (*)(uiList *ui_list, wmRegionListenerParams *params)

Listen to notifiers. Only for lists defined in C.

Definition at line 544 of file BKE_screen.hh.

Enumeration Type Documentation

anonymous enum

anonymous enum

PanelType.flag

Enumerator
PANEL_TYPE_DEFAULT_CLOSED
PANEL_TYPE_NO_HEADER
PANEL_TYPE_HEADER_EXPAND	Makes buttons in the header shrink/stretch to fill full layout width.
PANEL_TYPE_LAYOUT_VERT_BAR
PANEL_TYPE_INSTANCED	This panel type represents data external to the UI.
PANEL_TYPE_NO_SEARCH	Don't search panels with this type during property search.

Definition at line 387 of file BKE_screen.hh.

ARegionDrawLockFlags

enum ARegionDrawLockFlags

Enumerator
REGION_DRAW_LOCK_NONE
REGION_DRAW_LOCK_RENDER
REGION_DRAW_LOCK_BAKING
REGION_DRAW_LOCK_ALL

Definition at line 202 of file BKE_screen.hh.

AssetShelfTypeFlag

enum AssetShelfTypeFlag

Enumerator
ASSET_SHELF_TYPE_FLAG_NO_ASSET_DRAG	Do not trigger asset dragging on drag events. Drag events can be overridden with custom keymap items then.
ASSET_SHELF_TYPE_FLAG_DEFAULT_VISIBLE
ASSET_SHELF_TYPE_FLAG_STORE_CATALOGS_IN_PREFS
ASSET_SHELF_TYPE_FLAG_MAX

Definition at line 636 of file BKE_screen.hh.

MenuTypeFlag

enum class MenuTypeFlag

strong

Enumerator
ContextDependent	Whether the menu depends on data retrieved via CTX_data_pointer_get. If it is context dependent, menu search has to scan it in different contexts.
SearchOnKeyPress	Automatically start searching in the menu when pressing a key.

Definition at line 589 of file BKE_screen.hh.

Function Documentation

BKE_area_find_region_active_win()

ARegion * BKE_area_find_region_active_win

(

const ScrArea *

area

)

Definition at line 853 of file screen.cc.

References BKE_area_find_region_type(), BLI_findlink(), ScrArea::region_active_win, ScrArea::regionbase, ARegion::regiontype, and RGN_TYPE_WINDOW.

Referenced by ED_undo_operator_repeat(), ED_view3d_context_activate(), ED_view3d_context_rv3d(), texture_paint_image_from_view_exec(), and wm_operator_call_internal().

BKE_area_find_region_type()

ARegion * BKE_area_find_region_type	(	const ScrArea *	area,
		int	region_type )

Find a region of type region_type in the currently active space of area.

Note

This does not work if the region to look up is not in the active space. Use BKE_spacedata_find_region_type if that may be the case.

Definition at line 840 of file screen.cc.

References LISTBASE_FOREACH, and ScrArea::regionbase.

Referenced by blender::ed::asset::shelf::active_shelf_from_area(), ANIM_deselect_keys_in_animation_editors(), ANIM_frame_channel_y_extents(), animchannels_select_filter_invoke(), BKE_area_find_region_active_win(), BKE_spacedata_find_region_type(), blend_file_thumb_from_camera(), blo_do_versions_260(), blo_do_versions_430(), blender::ui::bonedropper_set_draw_callback_region(), buttons_start_filter_exec(), blender::ed::vse::channel_draw_context_init(), clip_refresh(), console_clear_exec(), console_clear_line_exec(), console_delete_exec(), console_history_append_exec(), console_history_cycle_exec(), console_indent_exec(), console_insert_exec(), console_modal_select_apply(), console_move_exec(), console_paste_exec(), console_scrollback_append_exec(), console_select_set_invoke(), console_selectword_invoke(), console_unindent_exec(), context_find_graph_editor(), datadropper_set_draw_callback_region(), do_version_area_change_space_to_space_action(), do_versions_area_ensure_tool_region(), ED_area_type_hud_ensure(), ED_drivers_editor_init(), ed_markers_poll_markers_exist_visible(), ED_screens_header_tools_menu_create(), ED_text_activate_in_screen(), ED_view3d_gizmo_ruler_remove_by_gpencil_layer(), blender::ed::animrig::ensure_asset_ui_visible(), file_refresh(), file_smoothscroll_invoke(), graphkeys_channel_view_pick_invoke(), graphkeys_view_selected_channels_exec(), hud_panel_operator_redo_poll(), hud_region_add(), menu_items_from_ui_create(), blender::ed::space_node::node_area_listener(), blender::ed::outliner::outliner_deactivate(), blender::ed::outliner::outliner_start_filter_exec(), blender::ed::space_node::viewer_linking::position_viewer_node(), region_scale_toggle_hidden(), region_toggle_exec(), blender::ed::asset::screenshot_preview_exec(), blender::ed::space_node::snode_set_context(), space_text_scroll_to_cursor_with_area(), blender::ed::spreadsheet::spreadsheet_main_region_draw(), text_autocomplete_modal(), text_has_properties_region(), UI_view2d_fromcontext_rwin(), userpref_execute_region_poll(), userpref_show_exec(), v3d_cursor_snap_draw_fn(), v3d_cursor_snap_poll_fn(), wm_handler_fileselect_do(), wm_keymap_item_find_props(), wm_operator_call_internal(), and WM_window_cursor_keymap_status_refresh().

BKE_area_find_region_xy()

ARegion * BKE_area_find_region_xy	(	const ScrArea *	area,
		int	regiontype,
		const int	xy[2] )

Definition at line 869 of file screen.cc.

References BLI_rcti_isect_pt_v(), ELEM, LISTBASE_FOREACH, ScrArea::regionbase, RGN_TYPE_ANY, and xy.

Referenced by annotation_draw_modal(), BKE_screen_find_main_region_at_xy(), blender::ui::bonedropper_sample_pt(), datadropper_id_sample_pt(), depthdropper_depth_sample_pt(), eyedropper_color_sample_fl(), eyedropper_cryptomatte_sample_fl(), eyedropper_get_property_button_under_mouse(), blender::ed::sculpt_paint::dyntopo::sample_detail(), v3d_cursor_snap_draw_fn(), wm_dropbox_active(), and wm_handler_op_context_get_if_valid().

BKE_area_region_copy()

ARegion * BKE_area_region_copy	(	const SpaceType *	st,
		const ARegion *	region )

Definition at line 344 of file screen.cc.

References BKE_regiontype_from_id(), BLI_duplicatelist(), BLI_listbase_clear(), ARegionType::duplicate, ARegion::flag, MEM_dupallocN(), ARegion::next, panel_list_copy(), ARegion::panels, ARegion::panels_category_active, ARegion::prev, ARegion::regiondata, ARegion::regiontype, RGN_FLAG_TEMP_REGIONDATA, ARegion::runtime, ARegion::ui_lists, ARegion::ui_previews, and ARegion::view_states.

Referenced by ED_area_data_copy(), property_search_all_tabs(), region_copylist(), and region_quadview_exec().

BKE_area_region_free()

void BKE_area_region_free	(	SpaceType *	st,
		ARegion *	region )

Doesn't free the region itself.

Definition at line 591 of file screen.cc.

References BKE_area_region_panels_free(), BKE_regiontype_from_id(), BLI_freelistN(), ARegion::flag, ARegionType::free, IDP_FreeProperty(), LISTBASE_FOREACH, MEM_SAFE_FREE, ARegion::panels, ARegion::panels_category_active, printf, region_free_gizmomap_callback, ARegion::regiondata, ARegion::regiontype, RGN_FLAG_TEMP_REGIONDATA, ARegion::runtime, ARegion::ui_lists, ARegion::ui_previews, and ARegion::view_states.

Referenced by BKE_screen_area_blend_read_after_liblink(), BKE_screen_area_free(), BKE_spacedata_freelist(), blo_do_versions_250(), blo_do_versions_270(), blo_do_versions_280(), do_version_area_change_space_to_space_action(), ED_area_data_copy(), ED_region_remove(), property_search_all_tabs(), regions_remove_invalid(), screen_free_data(), and ui_region_temp_remove().

BKE_area_region_new()

ARegion * BKE_area_region_new

(

)

Definition at line 381 of file screen.cc.

References MEM_callocN(), and ARegion::runtime.

Referenced by action_create(), area_add_header_region(), area_add_window_regions(), blo_do_versions_250(), blo_do_versions_260(), blo_do_versions_280(), buttons_create(), clip_create(), console_create(), do_version_action_editor_properties_region(), do_versions_add_region(), do_versions_add_region_if_not_found(), do_versions_ensure_region(), file_create(), graph_create(), hud_region_add(), image_create(), info_create(), nla_create(), blender::ed::space_node::node_create(), blender::ed::outliner::outliner_create(), script_create(), blender::ed::vse::sequencer_create(), blender::ed::spreadsheet::spreadsheet_create(), statusbar_create(), text_create(), text_has_properties_region(), topbar_create(), ui_region_temp_add(), userpref_create(), and view3d_create().

BKE_area_region_panels_free()

void BKE_area_region_panels_free

(

ListBase *

panels

)

Definition at line 579 of file screen.cc.

References area_region_panels_free_recursive(), BLI_listbase_clear(), and LISTBASE_FOREACH_MUTABLE.

Referenced by BKE_area_region_free(), blo_update_defaults_screen(), and ED_region_property_search().

BKE_panel_free()

void BKE_panel_free

(

Panel *

panel

)

Definition at line 557 of file screen.cc.

References Panel::activedata, BLI_remlink(), Panel::drawname, layout_panel_state_delete(), Panel::layout_panel_states, LISTBASE_FOREACH_MUTABLE, MEM_freeN(), MEM_SAFE_FREE, Panel::runtime, and state.

Referenced by area_region_panels_free_recursive(), panel_delete(), ui_paneltype_draw_impl(), and ui_popup_block_free().

BKE_panel_layout_panel_state_ensure()

LayoutPanelState * BKE_panel_layout_panel_state_ensure	(	Panel *	panel,
		blender::StringRef	idname,
		bool	default_closed )

Get the layout panel state for the given idname. If it does not exist yet, initialize a new panel state with the given default value.

Definition at line 514 of file screen.cc.

References BLI_addtail(), BLI_strdupn(), blender::StringRefBase::data(), LAYOUT_PANEL_STATE_FLAG_OPEN, Panel::layout_panel_states, Panel::layout_panel_states_clock, LISTBASE_FOREACH, MEM_callocN(), SET_FLAG_FROM_TEST, blender::StringRefBase::size(), and state.

Referenced by blender::nodes::draw_geometry_nodes_operator_redo_ui(), uiLayout::panel(), and blender::panel_draw().

BKE_panel_new()

Panel * BKE_panel_new

(

PanelType *

panel_type

)

Create and free panels.

Definition at line 540 of file screen.cc.

References PanelType::idname, MEM_callocN(), Panel::panelname, Panel::runtime, STRNCPY(), and Panel::type.

Referenced by panel_add_instanced(), panel_list_copy(), UI_panel_begin(), ui_paneltype_draw_impl(), and UI_popup_dummy_panel_set().

BKE_region_callback_free_gizmomap_set()

void BKE_region_callback_free_gizmomap_set

(

void(*

callback )(wmGizmoMap *)

)

Gizmo-maps of a region need to be freed with the region. Uses callback to avoid low-level call.

Definition at line 509 of file screen.cc.

References region_free_gizmomap_callback.

Referenced by WM_init().

BKE_region_callback_refresh_tag_gizmomap_set()

void BKE_region_callback_refresh_tag_gizmomap_set

(

void(*

callback )(wmGizmoMap *)

)

Definition at line 476 of file screen.cc.

References region_refresh_tag_gizmomap_callback.

Referenced by WM_init().

BKE_region_find_in_listbase_by_type()

ARegion * BKE_region_find_in_listbase_by_type	(	const ListBase *	regionbase,
		const int	region_type )

Find a region of type region_type in provided regionbase.

Note

this is useful for versioning where either the #Area or SpaceLink regionbase are typical inputs

Definition at line 829 of file screen.cc.

References LISTBASE_FOREACH.

Referenced by blo_do_versions_300(), and do_versions_after_linking_300().

BKE_regiontype_from_id()

ARegionType * BKE_regiontype_from_id	(	const SpaceType *	st,
		int	regionid )

Definition at line 261 of file screen.cc.

References LISTBASE_FOREACH, and SpaceType::regiontypes.

Referenced by area_offscreen_init(), BKE_area_region_copy(), BKE_area_region_free(), blender::ui::bonedropper_init(), blender::ui::bonedropper_set_draw_callback_region(), datadropper_init(), datadropper_set_draw_callback_region(), depthdropper_init(), drw_callbacks_post_scene(), ED_area_and_region_types_init(), ED_area_type_hud_ensure(), ED_view3d_buttons_region_layout_ex(), pyrna_callback_classmethod_add(), pyrna_callback_classmethod_remove(), regions_remove_invalid(), uiItemPopoverPanelFromGroup(), wm_xr_raycast_init(), and wm_xr_raycast_uninit().

BKE_screen_area_blend_read_after_liblink()

void BKE_screen_area_blend_read_after_liblink	(	BlendLibReader *	reader,
		ID *	parent_id,
		ScrArea *	area )

Called after lib linking process is done, to perform some validation on the read data, or some complex specific reading process that requires the data to be fully read and ID pointers to be valid.

Definition at line 1458 of file screen.cc.

References BKE_area_region_free(), BKE_spacetype_from_id(), SpaceType::blend_read_after_liblink, BLI_freelinkN(), ListBase::first, LISTBASE_FOREACH, LISTBASE_FOREACH_MUTABLE, ScrArea::regionbase, regions_remove_invalid(), and ScrArea::spacedata.

Referenced by screen_blend_read_after_liblink(), and window_manager_blend_read_after_liblink().

BKE_screen_area_free()

void BKE_screen_area_free

(

ScrArea *

area

)

Doesn't free the area itself.

Definition at line 632 of file screen.cc.

References ScrArea::actionzones, BKE_area_region_free(), BKE_spacedata_freelist(), BKE_spacetype_from_id(), BLI_freelistN(), ScrArea::global, LISTBASE_FOREACH, MEM_SAFE_FREE, ScrArea::regionbase, ScrArea::spacedata, and ScrArea::spacetype.

Referenced by BKE_screen_area_map_free(), blo_do_versions_280(), ED_area_offscreen_free(), ED_area_swapspace(), and screen_delarea().

BKE_screen_area_map_blend_read_data()

bool BKE_screen_area_map_blend_read_data	(	BlendDataReader *	reader,
		ScrAreaMap *	area_map )

Returns

false on error.

Definition at line 1412 of file screen.cc.

References ScrAreaMap::areabase, BKE_screen_sort_scrvert(), BLI_remlink(), BLO_read_struct, BLO_read_struct_list, direct_link_area(), ScrAreaMap::edgebase, LISTBASE_FOREACH, and ScrAreaMap::vertbase.

Referenced by BKE_screen_blend_read_data(), and window_manager_blend_read_data().

BKE_screen_area_map_blend_write()

void BKE_screen_area_map_blend_write	(	BlendWriter *	writer,
		ScrAreaMap *	area_map )

Definition at line 1191 of file screen.cc.

References ScrAreaMap::areabase, BLO_write_struct, BLO_write_struct_list, ScrArea::butspacetype, ScrAreaMap::edgebase, ScrArea::global, LISTBASE_FOREACH, SPACE_EMPTY, ScrArea::spacetype, ScrAreaMap::vertbase, and write_area().

Referenced by screen_blend_write(), and window_manager_blend_write().

BKE_screen_area_map_find_area_xy()

ScrArea * BKE_screen_area_map_find_area_xy	(	const ScrAreaMap *	areamap,
		int	spacetype,
		const int	xy[2] )

References xy.

BKE_screen_area_map_free()

void BKE_screen_area_map_free

(

ScrAreaMap *

area_map

)

Definition at line 648 of file screen.cc.

References ScrAreaMap::areabase, BKE_screen_area_free(), BLI_freelistN(), ScrAreaMap::edgebase, LISTBASE_FOREACH_MUTABLE, and ScrAreaMap::vertbase.

Referenced by ED_screen_global_areas_refresh(), screen_free_data(), and wm_window_free().

BKE_screen_blend_read_data()

bool BKE_screen_blend_read_data	(	BlendDataReader *	reader,
		bScreen *	screen )

Cannot use IDTypeInfo callback yet, because of the return value.

Definition at line 136 of file screen.cc.

References bScreen::active_region, bScreen::animtimer, AREAMAP_FROM_SCREEN, BKE_previewimg_blend_read(), BKE_screen_area_map_blend_read_data(), BLO_read_struct, bScreen::context, ListBase::first, bScreen::id, ListBase::last, ID::name, bScreen::preview, printf, bScreen::regionbase, bScreen::scrubbing, and bScreen::tool_tip.

Referenced by direct_link_id().

BKE_screen_find_area_from_space()

ARegion ARegion ScrArea * BKE_screen_find_area_from_space	(	const bScreen *	screen,
		const SpaceLink *	sl )

Note

Ideally we can get the area from the context, there are a few places however where this isn't practical.

References ATTR_WARN_UNUSED_RESULT, min, and ptr.

BKE_screen_find_area_xy()

ScrArea ScrArea * BKE_screen_find_area_xy	(	const bScreen *	screen,
		int	spacetype,
		const int	xy[2] )

References ATTR_WARN_UNUSED_RESULT, data, v2, and xy.

Referenced by actionzone_modal(), area_join_init(), area_join_update_data(), area_split_modal(), depthdropper_depth_sample_pt(), ED_area_find_under_cursor(), ED_screen_draw_edges(), eyedropper_color_sample_fl(), eyedropper_cryptomatte_sample_fl(), eyedropper_get_property_button_under_mouse(), eyedropper_win_area_find(), blender::ed::sculpt_paint::dyntopo::sample_detail(), screen_area_edge_from_cursor(), screenshot_invoke(), uiTemplateInputStatus(), wm_drags_draw(), and wm_dropbox_active().

BKE_screen_find_big_area()

ScrArea * BKE_screen_find_big_area	(	const bScreen *	screen,
		int	spacetype,
		short	min )

Note

Using this function is generally a last resort, you really want to be using the context when you can - campbell

Definition at line 938 of file screen.cc.

References bScreen::areabase, ELEM, LISTBASE_FOREACH, min, size(), SPACE_TYPE_ANY, ScrArea::spacetype, ScrArea::winx, and ScrArea::winy.

Referenced by blender::ed::object::bake_init_api_data(), blend_file_thumb_from_camera(), ED_text_activate_in_screen(), ED_view3d_context_activate(), render_view_open(), texture_paint_image_from_view_exec(), texture_paint_image_from_view_poll(), wm_file_write(), and wm_window_new_exec().

BKE_screen_find_edge()

ScrEdge * BKE_screen_find_edge	(	const bScreen *	screen,
		ScrVert *	v1,
		ScrVert *	v2 )

Definition at line 670 of file screen.cc.

References BKE_screen_sort_scrvert(), bScreen::edgebase, LISTBASE_FOREACH, and v2.

Referenced by area_findsharededge(), BKE_screen_remove_unused_scredges(), and screen_geom_vertices_scale_pass().

BKE_screen_find_main_region_at_xy()

ARegion ARegion * BKE_screen_find_main_region_at_xy	(	const bScreen *	screen,
		int	space_type,
		const int	xy[2] )

References xy.

BKE_screen_find_region_type()

ARegion * BKE_screen_find_region_type	(	const bScreen *	screen,
		int	region_type )

Note

This is only for screen level regions (typically menus/popups).

Definition at line 885 of file screen.cc.

References LISTBASE_FOREACH, and bScreen::regionbase.

Referenced by blender::ed::sculpt_paint::paint_update_mouse_cursor().

BKE_screen_find_region_xy()

ARegion * BKE_screen_find_region_xy	(	const bScreen *	screen,
		int	regiontype,
		const int	xy[2] )

Note

This is only for screen level regions (typically menus/popups).

References ATTR_WARN_UNUSED_RESULT, and xy.

Referenced by ui_button_press_invoke().

BKE_screen_foreach_id_screen_area()

void BKE_screen_foreach_id_screen_area	(	LibraryForeachIDData *	data,
		ScrArea *	area )

Callback used by lib_query to walk over all ID usages (mimics foreach_id callback of IDTypeInfo structure).

Definition at line 92 of file screen.cc.

References BKE_LIB_FOREACHID_PROCESS_IDSUPER, BKE_spacetype_from_id(), data, SpaceType::foreach_id, ScrArea::full, IDWALK_CB_NOP, LISTBASE_FOREACH, and ScrArea::spacedata.

Referenced by screen_foreach_id(), and window_manager_foreach_id().

BKE_screen_free_data()

void BKE_screen_free_data

(

bScreen *

screen

)

Free (or release) any data used by this screen (does not free the screen itself).

Definition at line 659 of file screen.cc.

References bScreen::id, and screen_free_data().

Referenced by screen_data_copy().

BKE_screen_gizmo_tag_refresh()

ScrArea ScrArea void BKE_screen_gizmo_tag_refresh

(

bScreen *

screen

)

Definition at line 481 of file screen.cc.

References bScreen::areabase, LISTBASE_FOREACH, region_refresh_tag_gizmomap_callback, and ScrArea::regionbase.

Referenced by setup_app_data().

BKE_screen_header_alignment_reset()

void BKE_screen_header_alignment_reset

(

bScreen *

screen

)

Definition at line 1053 of file screen.cc.

References bScreen::areabase, bScreen::do_refresh, ELEM, LISTBASE_FOREACH, ScrArea::regionbase, RGN_ALIGN_BOTTOM, RGN_ALIGN_TOP, RGN_TYPE_FOOTER, RGN_TYPE_HEADER, RGN_TYPE_TOOL_HEADER, SPACE_FILE, SPACE_OUTLINER, SPACE_PROPERTIES, SPACE_USERPREF, ScrArea::spacetype, U, and USER_HEADER_BOTTOM.

Referenced by ED_screens_init().

BKE_screen_is_fullscreen_area()

bool BKE_screen_is_fullscreen_area

(

const bScreen *

screen

)

Definition at line 1043 of file screen.cc.

References ELEM, SCREENFULL, SCREENMAXIMIZED, and bScreen::state.

Referenced by ED_workspace_layout_delete(), ED_workspace_layout_duplicate(), wm_check_screen_switch_supported(), and workspace_layout_set_poll().

BKE_screen_is_used()

bool BKE_screen_is_used

(

const bScreen *

screen

)

Definition at line 1048 of file screen.cc.

References bScreen::winid.

Referenced by screen_is_used_by_other_window(), and workspace_layout_set_poll().

BKE_screen_path_from_screen_to_space()

ARegion ARegion ScrArea std::optional< std::string > BKE_screen_path_from_screen_to_space

(

const PointerRNA *

ptr

)

Note

used to get proper RNA paths for spaces (editors).

Definition at line 918 of file screen.cc.

References bScreen::areabase, BLI_assert_unreachable, BLI_findindex(), GS, ID_SCR, LISTBASE_FOREACH_INDEX, ptr, and ScrArea::spacedata.

BKE_screen_remove_double_scredges()

void BKE_screen_remove_double_scredges

(

bScreen *

screen

)

Definition at line 743 of file screen.cc.

References BLI_remlink(), bScreen::edgebase, LISTBASE_FOREACH, MEM_freeN(), ScrEdge::next, ScrEdge::v1, and ScrEdge::v2.

Referenced by area_join_exit(), area_move_exit(), area_split(), area_split_exit(), and blo_do_versions_280().

BKE_screen_remove_double_scrverts()

void BKE_screen_remove_double_scrverts

(

bScreen *

screen

)

Definition at line 691 of file screen.cc.

References bScreen::areabase, BKE_screen_sort_scrvert(), BLI_remlink(), bScreen::edgebase, LISTBASE_FOREACH, LISTBASE_FOREACH_MUTABLE, MEM_freeN(), ScrVert::newv, ScrVert::next, ScrArea::v1, ScrArea::v2, ScrArea::v3, ScrArea::v4, ScrVert::vec, bScreen::vertbase, vec2s::x, and vec2s::y.

Referenced by area_move_exit(), area_split(), area_split_exit(), and screen_area_join_aligned().

BKE_screen_remove_unused_scredges()

void BKE_screen_remove_unused_scredges

(

bScreen *

screen

)

Definition at line 759 of file screen.cc.

References bScreen::areabase, BKE_screen_find_edge(), BLI_remlink(), bScreen::edgebase, ScrEdge::flag, LISTBASE_FOREACH_INDEX, LISTBASE_FOREACH_MUTABLE, MEM_freeN(), printf, ScrArea::v1, ScrArea::v2, ScrArea::v3, and ScrArea::v4.

Referenced by area_join_exit(), area_split(), and blo_do_versions_280().

BKE_screen_remove_unused_scrverts()

void BKE_screen_remove_unused_scrverts

(

bScreen *

screen

)

Definition at line 804 of file screen.cc.

References BLI_remlink(), bScreen::edgebase, LISTBASE_FOREACH, LISTBASE_FOREACH_MUTABLE, MEM_freeN(), and bScreen::vertbase.

Referenced by area_join_exit(), and blo_do_versions_280().

BKE_screen_runtime_refresh_for_blendfile()

void BKE_screen_runtime_refresh_for_blendfile

(

bScreen *

screen

)

Refresh any screen data that should be set on file-load with "Load UI" disabled.

Definition at line 496 of file screen.cc.

References bScreen::areabase, ScrArea_Runtime::is_tool_set, LISTBASE_FOREACH, ScrArea::runtime, and ScrArea_Runtime::tool.

Referenced by setup_app_data().

BKE_screen_sort_scrvert()

void BKE_screen_sort_scrvert	(	ScrVert **	v1,
		ScrVert **	v2 )

Definition at line 682 of file screen.cc.

References v2.

Referenced by BKE_screen_area_map_blend_read_data(), BKE_screen_find_edge(), BKE_screen_remove_double_scrverts(), screen_data_copy(), and screen_geom_edge_add_ex().

BKE_screen_view3d_do_versions_250()

void BKE_screen_view3d_do_versions_250	(	View3D *	v3d,
		ListBase *	regions )

And as patch for 2.48 and older. For the saved 2.50 files without regiondata.

Definition at line 1318 of file screen.cc.

References copy_qt_qt(), copy_v3_v3(), RegionView3D::dist, View3D::gridsubdiv, LISTBASE_FOREACH, MEM_callocN(), RegionView3D::ofs, RegionView3D::persp, RGN_TYPE_WINDOW, RegionView3D::view, and RegionView3D::viewquat.

Referenced by area_add_window_regions(), direct_link_area(), and view3d_space_blend_read_data().

BKE_screen_view3d_scene_sync()

void BKE_screen_view3d_scene_sync	(	bScreen *	screen,
		Scene *	scene )

Definition at line 998 of file screen.cc.

References bScreen::areabase, BKE_screen_view3d_sync(), LISTBASE_FOREACH, SPACE_VIEW3D, and ScrArea::spacedata.

Referenced by ed_marker_camera_bind_exec(), ed_marker_move_apply(), ED_update_for_newframe(), ED_workspace_scene_data_sync(), screen_change_update(), and setup_app_data().

BKE_screen_view3d_shading_blend_read_data()

void BKE_screen_view3d_shading_blend_read_data	(	BlendDataReader *	reader,
		View3DShading *	shading )

Definition at line 1090 of file screen.cc.

References BLO_read_struct, IDP_BlendDataRead, and View3DShading::prop.

Referenced by direct_link_wm_xr_data(), scene_blend_read_data(), and view3d_space_blend_read_data().

BKE_screen_view3d_shading_blend_write()

void BKE_screen_view3d_shading_blend_write	(	BlendWriter *	writer,
		View3DShading *	shading )

Definition at line 1083 of file screen.cc.

References IDP_BlendWrite(), and View3DShading::prop.

Referenced by scene_blend_write(), view3d_space_blend_write(), and write_wm_xr_data().

BKE_screen_view3d_shading_init()

void BKE_screen_view3d_shading_init

(

View3DShading *

shading

)

Definition at line 1011 of file screen.cc.

References DNA_struct_default_get.

Referenced by blo_do_versions_280(), and object_preview_render().

BKE_screen_view3d_sync()

void BKE_screen_view3d_sync	(	View3D *	v3d,
		Scene *	scene )

Definition at line 980 of file screen.cc.

References Scene::camera, View3D::camera, LISTBASE_FOREACH, View3D::localvd, RegionView3D::persp, View3D::regionbase, RGN_TYPE_WINDOW, RV3D_CAMOB, RV3D_PERSP, and View3D::scenelock.

Referenced by BKE_screen_view3d_scene_sync(), screen_set_3dview_camera(), and view3d_main_region_listener().

BKE_screen_view3d_zoom_from_fac()

float BKE_screen_view3d_zoom_from_fac

(

float

zoomfac

)

Definition at line 1038 of file screen.cc.

References M_SQRT2, and sqrtf.

Referenced by ED_view3d_camera_view_zoom_scale(), view3d_center_camera_exec(), view3d_set_1_to_1_viewborder(), and view_zoom_to_window_xy_camera().

BKE_screen_view3d_zoom_to_fac()

float BKE_screen_view3d_zoom_to_fac

(

float

camzoom

)

Definition at line 1033 of file screen.cc.

References M_SQRT2, and powf.

Referenced by BKE_camera_params_from_view3d(), ED_view3d_camera_view_pan(), ED_view3d_camera_view_zoom_scale(), ED_view3d_win_to_3d(), ED_view3d_win_to_3d_with_shift(), view_zoom_to_window_xy_camera(), and viewzoom_apply_camera().

BKE_spacedata_callback_id_remap_set()

void BKE_spacedata_callback_id_remap_set

(

void(*

func )(ScrArea *area, SpaceLink *sl, ID *old_id, ID *new_id)

)

Definition at line 459 of file screen.cc.

References spacedata_id_remap_cb.

Referenced by WM_init().

BKE_spacedata_copylist()

void BKE_spacedata_copylist	(	ListBase *	lb_dst,
		ListBase *	lb_src )

Parameters

lb_dst

should be empty (will be cleared).

Definition at line 400 of file screen.cc.

References BKE_spacetype_from_id(), BLI_addtail(), BLI_listbase_clear(), SpaceType::duplicate, LISTBASE_FOREACH, region_copylist(), and SpaceLink::regionbase.

Referenced by ED_area_data_copy().

BKE_spacedata_draw_locks()

void BKE_spacedata_draw_locks

(

ARegionDrawLockFlags

lock_flags

)

Facility to set locks for drawing to survive (render) threads accessing drawing data.

Note

Should be replaced in future by better local data handling for threads.

Effect of multiple calls to this function is not accumulative. The locking flags will be set to by the last call.

Definition at line 417 of file screen.cc.

References get_space_types(), and LISTBASE_FOREACH.

Referenced by dpaint_bake_startjob(), fluid_bake_startjob(), fluid_free_startjob(), lineart_bake_startjob(), render_drawlock(), and WM_set_locked_interface_with_flags().

BKE_spacedata_find_region_type()

ARegion * BKE_spacedata_find_region_type	(	const SpaceLink *	slink,
		const ScrArea *	area,
		int	region_type )

Version of BKE_area_find_region_type that also works if slink is not the active space of area.

Definition at line 431 of file screen.cc.

References BKE_area_find_region_type(), BLI_assert, BLI_findindex(), ListBase::first, LISTBASE_FOREACH, ScrArea::regionbase, SpaceLink::regionbase, and ScrArea::spacedata.

Referenced by blo_do_versions_280().

BKE_spacedata_freelist()

void BKE_spacedata_freelist

(

ListBase *

lb

)

Definition at line 299 of file screen.cc.

References BKE_area_region_free(), BKE_spacetype_from_id(), BLI_freelistN(), SpaceType::free, and LISTBASE_FOREACH.

Referenced by BKE_screen_area_free(), ED_area_data_copy(), and spacedata_cleanup_exec().

BKE_spacedata_id_unref()

void BKE_spacedata_id_unref	(	ScrArea *	area,
		SpaceLink *	sl,
		ID *	id )

Currently unused!

Definition at line 464 of file screen.cc.

References spacedata_id_remap_cb.

BKE_spacetype_exists()

bool BKE_spacetype_exists

(

int

spaceid

)

Definition at line 288 of file screen.cc.

References BKE_spacetype_from_id().

Referenced by direct_link_area().

BKE_spacetype_from_id()

SpaceType * BKE_spacetype_from_id

(

int

spaceid

)

Definition at line 251 of file screen.cc.

References get_space_types().

Referenced by area_init_type_fallback(), area_offscreen_init(), BKE_screen_area_blend_read_after_liblink(), BKE_screen_area_free(), BKE_screen_foreach_id_screen_area(), BKE_spacedata_copylist(), BKE_spacedata_freelist(), BKE_spacetype_exists(), BKE_spacetype_register(), blo_do_versions_250(), blo_do_versions_280(), blender::ui::bonedropper_init(), datadropper_init(), depthdropper_init(), direct_link_area(), do_version_area_change_space_to_space_action(), drw_callbacks_post_scene(), ED_area_and_region_types_init(), ED_area_data_copy(), ED_area_newspace(), ED_spacedata_id_remap(), ED_spacedata_id_remap_single(), ED_view3d_buttons_region_layout_ex(), pyrna_callback_classmethod_add(), pyrna_callback_classmethod_remove(), screen_area_spacelink_add(), uiItemPopoverPanelFromGroup(), wm_xr_raycast_init(), wm_xr_raycast_uninit(), and write_area().

BKE_spacetype_register()

void BKE_spacetype_register

(

std::unique_ptr< SpaceType >

st

)

Definition at line 276 of file screen.cc.

References BKE_spacetype_from_id(), get_space_types(), SpaceType::name, and printf.

Referenced by ED_spacetype_action(), ED_spacetype_buttons(), ED_spacetype_clip(), ED_spacetype_console(), ED_spacetype_file(), ED_spacetype_image(), ED_spacetype_info(), ED_spacetype_ipo(), ED_spacetype_nla(), ED_spacetype_node(), ED_spacetype_outliner(), ED_spacetype_script(), blender::ed::vse::ED_spacetype_sequencer(), ED_spacetype_statusbar(), ED_spacetype_text(), ED_spacetype_topbar(), ED_spacetype_userpref(), ED_spacetype_view3d(), and blender::ed::spreadsheet::register_spacetype().

BKE_spacetypes_free()

void BKE_spacetypes_free

(

)

Only for quitting blender.

Definition at line 246 of file screen.cc.

References get_space_types().

Referenced by BKE_blender_free().

BKE_spacetypes_list()

blender::Span< std::unique_ptr< SpaceType > > BKE_spacetypes_list

(

)

Definition at line 271 of file screen.cc.

References get_space_types().

Referenced by ED_spacemacros_init(), ED_spacetypes_init(), and ED_spacetypes_keymap().

ENUM_OPERATORS()

ENUM_OPERATORS	(	AssetShelfTypeFlag	,
		ASSET_SHELF_TYPE_FLAG_MAX	)

References ASSET_SHELF_TYPE_FLAG_MAX.