Blender V5.3
blender::bke::WindowManagerRuntime Struct Reference

#include <BKE_wm_runtime.hh>

Public Member Functions

 WindowManagerRuntime ()
 ~WindowManagerRuntime ()

Public Attributes

wmWindow * windrawable = nullptr
wmWindow * winactive = nullptr
bool is_interface_locked = false
char save_modified_images_when_file_is_saved = true
bool break_events_handling = false
ReportList reports
ListBaseT< wmNotifier > notifier_queue = {nullptr, nullptr}
wmNotifierQueueSet notifier_queue_set
const wmNotifier * notifier_current = nullptr
ListBaseT< wmOperator > operators = {nullptr, nullptr}
ListBaseT< wmPaintCursor > paintcursors = {nullptr, nullptr}
ListBaseT< wmKeyConfig > keyconfigs = {nullptr, nullptr}
ListBaseT< wmTimer > timers = {nullptr, nullptr}
ListBaseT< wmJob > jobs = {nullptr, nullptr}
ListBaseT< wmDrag > drags = {nullptr, nullptr}
wmKeyConfig * defaultconf = nullptr
wmKeyConfig * addonconf = nullptr
wmKeyConfig * userconf = nullptr
UndoStack * undo_stack = nullptr
wmMsgBus * message_bus = nullptr

Detailed Description

Definition at line 47 of file BKE_wm_runtime.hh.

Constructor & Destructor Documentation

◆ WindowManagerRuntime()

blender::bke::WindowManagerRuntime::WindowManagerRuntime ( )

Definition at line 22 of file wm_runtime.cc.

References blender::BKE_reports_init(), reports, and blender::RPT_STORE.

◆ ~WindowManagerRuntime()

Member Data Documentation

◆ addonconf

wmKeyConfig* blender::bke::WindowManagerRuntime::addonconf = nullptr

Addon configuration.

Definition at line 117 of file BKE_wm_runtime.hh.

Referenced by blender::wm_file_read_setup_wm_use_new().

◆ break_events_handling

bool blender::bke::WindowManagerRuntime::break_events_handling = false

Indicates the main loop (WM_main()) to stop processing the event queue and move to the next step. The Remaining events will then be processed during the next iteration of the loop.

This is used e.g. to avoid handling events immediately after an undo/redo action, when UI has not yet been updated.

Definition at line 71 of file BKE_wm_runtime.hh.

Referenced by blender::WM_event_handling_break().

◆ defaultconf

wmKeyConfig* blender::bke::WindowManagerRuntime::defaultconf = nullptr

Default configuration.

Definition at line 114 of file BKE_wm_runtime.hh.

Referenced by blender::wm_file_read_setup_wm_use_new().

◆ drags

ListBaseT<wmDrag> blender::bke::WindowManagerRuntime::drags = {nullptr, nullptr}

Active dragged items.

Definition at line 111 of file BKE_wm_runtime.hh.

Referenced by ~WindowManagerRuntime().

◆ is_interface_locked

bool blender::bke::WindowManagerRuntime::is_interface_locked = false

Indicates whether interface is locked for user interaction.

Definition at line 59 of file BKE_wm_runtime.hh.

◆ jobs

ListBaseT<wmJob> blender::bke::WindowManagerRuntime::jobs = {nullptr, nullptr}

Threaded jobs manager.

Definition at line 108 of file BKE_wm_runtime.hh.

Referenced by blender::WM_jobs_has_running().

◆ keyconfigs

ListBaseT<wmKeyConfig> blender::bke::WindowManagerRuntime::keyconfigs = {nullptr, nullptr}

Known key configurations. This includes all the wmKeyConfig members (defaultconf, addonconf, etc).

Definition at line 102 of file BKE_wm_runtime.hh.

Referenced by blender::wm_file_read_setup_wm_use_new(), and ~WindowManagerRuntime().

◆ message_bus

wmMsgBus* blender::bke::WindowManagerRuntime::message_bus = nullptr

Definition at line 129 of file BKE_wm_runtime.hh.

Referenced by ~WindowManagerRuntime().

◆ notifier_current

const wmNotifier* blender::bke::WindowManagerRuntime::notifier_current = nullptr

The current notifier in the notifier_queue being handled (clear instead of freeing).

Definition at line 90 of file BKE_wm_runtime.hh.

◆ notifier_queue

ListBaseT<wmNotifier> blender::bke::WindowManagerRuntime::notifier_queue = {nullptr, nullptr}

Refresh/redraw wmNotifier structs.

Note
Once in the queue, notifiers should be considered read-only. With the exception of clearing notifiers for data which has been removed, see: NOTE_CATEGORY_TAG_CLEARED.

Definition at line 82 of file BKE_wm_runtime.hh.

Referenced by ~WindowManagerRuntime().

◆ notifier_queue_set

wmNotifierQueueSet blender::bke::WindowManagerRuntime::notifier_queue_set

For duplicate detection.

Note
keep in sync with notifier_queue adding/removing elements must also update this set.

Definition at line 87 of file BKE_wm_runtime.hh.

◆ operators

ListBaseT<wmOperator> blender::bke::WindowManagerRuntime::operators = {nullptr, nullptr}

Operator registry.

Definition at line 93 of file BKE_wm_runtime.hh.

Referenced by blender::ed::transform::gizmo_mesh_extrude_refresh(), and ~WindowManagerRuntime().

◆ paintcursors

ListBaseT<wmPaintCursor> blender::bke::WindowManagerRuntime::paintcursors = {nullptr, nullptr}

Extra overlay cursors to draw, like circles.

Definition at line 96 of file BKE_wm_runtime.hh.

Referenced by ~WindowManagerRuntime().

◆ reports

ReportList blender::bke::WindowManagerRuntime::reports

Information and error reports.

Definition at line 74 of file BKE_wm_runtime.hh.

Referenced by WindowManagerRuntime(), and ~WindowManagerRuntime().

◆ save_modified_images_when_file_is_saved

char blender::bke::WindowManagerRuntime::save_modified_images_when_file_is_saved = true

Indicates whether modified images should be saved when saving the blend file.

Definition at line 62 of file BKE_wm_runtime.hh.

◆ timers

ListBaseT<wmTimer> blender::bke::WindowManagerRuntime::timers = {nullptr, nullptr}

Active timers.

Definition at line 105 of file BKE_wm_runtime.hh.

Referenced by ~WindowManagerRuntime().

◆ undo_stack

◆ userconf

wmKeyConfig* blender::bke::WindowManagerRuntime::userconf = nullptr

User configuration.

Definition at line 120 of file BKE_wm_runtime.hh.

Referenced by blender::wm_file_read_setup_wm_use_new().

◆ winactive

wmWindow* blender::bke::WindowManagerRuntime::winactive = nullptr
Note
CTX_wm_window(C) is usually preferred. Avoid relying on this where possible as this may become NULL during when handling events that close or replace windows (e.g. opening a file). While this happens rarely in practice, it can cause difficult to reproduce bugs.

Definition at line 56 of file BKE_wm_runtime.hh.

Referenced by blender::ED_node_compositor_job().

◆ windrawable

wmWindow* blender::bke::WindowManagerRuntime::windrawable = nullptr

Separate active from drawable.

Definition at line 49 of file BKE_wm_runtime.hh.

Referenced by blender::wm_file_read_setup_wm_substitute_old_window().


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