Blender V5.3
blender::ARegionType Struct Reference

#include <BKE_screen.hh>

Public Attributes

ARegionType * next
ARegionType * prev
int regionid
void(*) init (wmWindowManager *wm, ARegion *region)
void(*) exit (wmWindowManager *wm, ARegion *region)
bool(*) poll (const RegionPollParams *params)
void(*) draw (const bContext *C, ARegion *region)
void(*) draw_overlay (const bContext *C, ARegion *region)
void(*) layout (const bContext *C, ARegion *region)
int(*) snap_size (const ARegion *region, int size, int axis)
void(*) listener (const wmRegionListenerParams *params)
void(*) message_subscribe (const wmRegionMessageSubscribeParams *params)
void(*) free (ARegion *)
void *(*) duplicate (void *poin)
void(*) cursor (wmWindow *win, ScrArea *area, ARegion *region)
bContextDataCallback context
void(*) on_poll_success (const bContext *C, ARegion *region)
void(*) on_user_resize (const ARegion *region)
void(*) on_view2d_changed (const bContext *C, ARegion *region)
std::optional< ARegionIMECursorState >(*) cursor_ime (wmWindow *win, const ScrArea *area, const ARegion *region, ARegionIMECursor *r_cursor)
ARegionTypeFlag flag
ListBaseT< RegionDrawCB > drawcalls
ListBaseT< PanelType > paneltypes
ListBaseT< HeaderType > headertypes
int minsizex
int minsizey
int prefsizex
int prefsizey
int keymapflag
short do_lock
short lock
bool clip_gizmo_events_by_ui
short event_cursor

Detailed Description

Definition at line 346 of file BKE_screen.hh.

Member Data Documentation

◆ clip_gizmo_events_by_ui

bool blender::ARegionType::clip_gizmo_events_by_ui

Don't handle gizmos events behind #ui::Block's with #BLOCK_CLIP_EVENTS flag set.

Definition at line 454 of file BKE_screen.hh.

Referenced by blender::ED_spacetype_node(), blender::ed::vse::ED_spacetype_sequencer(), and blender::wm_handlers_do_gizmo_handler().

◆ context

◆ cursor

◆ cursor_ime

std::optional< ARegionIMECursorState >(*) blender::ARegionType::cursor_ime(wmWindow *win, const ScrArea *area, const ARegion *region, ARegionIMECursor *r_cursor)

Report the IME cursor so the candidate window can be positioned, see ARegionIMECursorState for the results.

On #ARegionIMECursorState::PositionSet, r_cursor->rect is the region-relative cursor: used to position the IME popup. Otherwise r_cursor is left untouched.

Called on region activation and after each draw (when ARegionRuntime::do_ime is set) to position the IME candidate window.

Definition at line 413 of file BKE_screen.hh.

Referenced by blender::ED_region_do_draw(), blender::ED_spacetype_console(), blender::ed::vse::ED_spacetype_sequencer(), blender::ED_spacetype_text(), and blender::ED_spacetype_view3d().

◆ do_lock

short blender::ARegionType::do_lock

Return without drawing. lock is set by region definition, and copied to do_lock by render. Set as bitflag value in ARegionDrawLockFlags.

Definition at line 452 of file BKE_screen.hh.

Referenced by blender::BKE_spacedata_draw_locks(), blender::ED_region_cursor_set(), blender::ED_region_do_draw(), blender::ED_region_do_layout(), and blender::wm_event_do_region_handlers().

◆ draw

◆ draw_overlay

void(*) blender::ARegionType::draw_overlay(const bContext *C, ARegion *region)

Handler to draw overlays. This handler is called every draw loop.

Note
Some editors should return early if the interface is locked (check with CTX_wm_interface_locked) to avoid accessing scene data that another thread may be modifying

Definition at line 371 of file BKE_screen.hh.

Referenced by blender::ED_spacetype_action(), blender::ED_spacetype_ipo(), blender::ED_spacetype_nla(), blender::ed::vse::ED_spacetype_sequencer(), blender::wm_draw_window_onscreen(), and blender::wm_region_draw_overlay().

◆ drawcalls

ListBaseT<RegionDrawCB> blender::ARegionType::drawcalls

◆ duplicate

void *(*) blender::ARegionType::duplicate(void *poin)

Split region, copy data optionally.

Definition at line 384 of file BKE_screen.hh.

Referenced by blender::BKE_area_region_copy(), blender::ED_spacetype_image(), blender::ED_spacetype_node(), and blender::ED_spacetype_view3d().

◆ event_cursor

◆ exit

void(*) blender::ARegionType::exit(wmWindowManager *wm, ARegion *region)

Exit is called when the region is hidden or removed.

Definition at line 354 of file BKE_screen.hh.

Referenced by blender::area_offscreen_exit(), blender::ED_region_exit(), and blender::ED_spacetype_view3d().

◆ flag

◆ free

◆ headertypes

ListBaseT<HeaderType> blender::ARegionType::headertypes

◆ init

◆ keymapflag

◆ layout

◆ listener

◆ lock

◆ message_subscribe

◆ minsizex

int blender::ARegionType::minsizex

Hardcoded constraints, smaller than these values region is not visible.

Definition at line 442 of file BKE_screen.hh.

◆ minsizey

int blender::ARegionType::minsizey

Definition at line 442 of file BKE_screen.hh.

◆ next

ARegionType* blender::ARegionType::next

Definition at line 347 of file BKE_screen.hh.

◆ on_poll_success

void(*) blender::ARegionType::on_poll_success(const bContext *C, ARegion *region)

Called on every frame in which the region's poll succeeds, regardless of visibility, before drawing, visibility evaluation and initialization. Allows the region to override visibility.

Definition at line 396 of file BKE_screen.hh.

Referenced by blender::area_regions_poll(), blender::ED_spacetype_image(), blender::ED_spacetype_node(), and blender::ED_spacetype_view3d().

◆ on_user_resize

void(*) blender::ARegionType::on_user_resize(const ARegion *region)

Called whenever the user changes the region's size. Not called when the size is changed through other means, like to adjust for a scaled down window.

Definition at line 402 of file BKE_screen.hh.

Referenced by blender::ED_spacetype_image(), blender::ED_spacetype_node(), blender::ED_spacetype_view3d(), blender::quadview_size_modal(), and blender::region_scale_modal().

◆ on_view2d_changed

void(*) blender::ARegionType::on_view2d_changed(const bContext *C, 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).

Definition at line 413 of file BKE_screen.hh.

Referenced by blender::ed::vse::ED_spacetype_sequencer(), and blender::ui::view2d_curRect_changed().

◆ paneltypes

ListBaseT<PanelType> blender::ARegionType::paneltypes

Panels type definitions.

Definition at line 436 of file BKE_screen.hh.

Referenced by blender::buttons_context_register(), blender::buttons_main_region_layout_properties(), blender::buttons_navigation_bar_region_draw(), blender::ed::asset::shelf::catalog_selector_panel_register(), blender::ED_clip_buttons_register(), blender::ED_region_panels_ex(), blender::ED_region_panels_layout(), blender::ED_uvedit_buttons_register(), blender::ED_view3d_buttons_region_layout_ex(), blender::file_execute_region_panels_register(), blender::file_tool_props_region_panels_register(), blender::file_tools_region_panels_register(), blender::fmodifier_panel_register(), blender::fmodifier_subpanel_register(), blender::graph_buttons_register(), blender::ui::hud_panels_register(), blender::image_buttons_region_layout(), blender::image_buttons_register(), blender::modifier_panel_register(), blender::seq::modifier_panel_register(), blender::modifier_subpanel_register(), blender::nla_buttons_register(), blender::ed::space_node::node_tree_interface_panel_register(), blender::ui::panel_add_instanced(), blender::ui::panel_category_active_set(), blender::ui::Layout::popover_group(), blender::ed::asset::shelf::popover_panel_register(), blender::property_search_for_context(), blender::property_search_for_context(), blender::ed::spreadsheet::register_row_filter_panels(), blender::ui::register_scene_compositor_effects_panel(), blender::ed::vse::sequencer_buttons_register(), blender::shaderfx_panel_register(), blender::shaderfx_subpanel_register(), blender::side_region_search_all_categories(), blender::side_region_search_for_context(), blender::ed::spreadsheet::spreadsheet_data_set_region_panels_register(), blender::userpref_main_region_layout(), blender::userpref_panels_register(), and blender::view3d_buttons_register().

◆ poll

bool(*) blender::ARegionType::poll(const RegionPollParams *params)

Optional callback to decide whether the region should be treated as existing given the current context. When returning false, the region will be kept in storage, but is not available to the user in any way. Callbacks can assume that context has the owning area and space-data set.

Definition at line 361 of file BKE_screen.hh.

Referenced by blender::ED_spacetype_action(), blender::ED_spacetype_clip(), blender::ED_spacetype_file(), blender::ED_spacetype_image(), blender::ED_spacetype_ipo(), blender::ED_spacetype_node(), blender::ED_spacetype_project(), blender::ed::vse::ED_spacetype_sequencer(), blender::ED_spacetype_userpref(), blender::ED_spacetype_view3d(), and blender::region_poll().

◆ prefsizex

◆ prefsizey

◆ prev

ARegionType * blender::ARegionType::prev

Definition at line 347 of file BKE_screen.hh.

◆ regionid

◆ snap_size


The documentation for this struct was generated from the following file: