Blender V5.3
WM_toolsystem.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4#pragma once
5
9
10#include "BKE_paint_types.hh"
11
12namespace blender {
13
14struct Brush;
15struct IDProperty;
16struct Main;
17struct Paint;
18struct PointerRNA;
19struct Scene;
20struct ScrArea;
21struct StructRNA;
22struct WorkSpace;
23struct bContext;
24struct bToolRef;
25struct bToolRef_Runtime;
26struct ViewLayer;
29struct wmOperatorType;
30struct wmWindow;
32
33/* `wm_toolsystem.cc` */
34
35#define WM_TOOLSYSTEM_SPACE_MASK \
36 ((1 << SPACE_IMAGE) | (1 << SPACE_NODE) | (1 << SPACE_VIEW3D) | (1 << SPACE_SEQ))
37
40#define WM_TOOLSYSTEM_SPACE_MASK_MODE_FROM_SPACE ((1 << SPACE_IMAGE) | (1 << SPACE_SEQ))
41
45struct bToolKey {
47 int mode;
48};
49
51bToolRef *WM_toolsystem_ref_find(WorkSpace *workspace, const bToolKey *tkey);
52bool WM_toolsystem_ref_ensure(WorkSpace *workspace, const bToolKey *tkey, bToolRef **r_tref);
53
55 bContext *C, WorkSpace *workspace, const bToolKey *tkey, const char *name, bool cycle);
57
60
69
73std::optional<AssetWeakReference> WM_toolsystem_last_brush_asset_from_brush_type(
74 Scene *scene, const int brush_type, const PaintMode paint_mode);
75
76void WM_toolsystem_unlink(bContext *C, WorkSpace *workspace, const bToolKey *tkey);
77void WM_toolsystem_refresh(const bContext *C, WorkSpace *workspace, const bToolKey *tkey);
78void WM_toolsystem_reinit(bContext *C, WorkSpace *workspace, const bToolKey *tkey);
79
84void WM_toolsystem_refresh_all(const bContext *C, WorkSpace *workspace);
86
88 WorkSpace *workspace,
89 bToolRef *tref,
90 const bToolRef_Runtime *tref_rt,
91 const char *idname);
92
99void WM_toolsystem_ref_sync_from_context(Main *bmain, WorkSpace *workspace, bToolRef *tref);
100
101void WM_toolsystem_init(const bContext *C);
102
104 const Main &bmain, const Scene *scene, ViewLayer *view_layer, ScrArea *area, int space_type);
106 const Main &bmain, const Scene *scene, ViewLayer *view_layer, ScrArea *area, bToolKey *tkey);
107
110 bContext *C, WorkSpace *workspace, const Scene *scene, ViewLayer *view_layer, ScrArea *area);
111
117
120 wmMsgSubscribeKey *msg_key,
121 wmMsgSubscribeValue *msg_val);
122
126 const char *idname,
127 StructRNA *type,
128 PointerRNA *r_ptr);
129
130#define WM_toolsystem_ref_properties_ensure_from_operator(tref, ot, r_ptr) \
131 WM_toolsystem_ref_properties_ensure_ex(tref, (ot)->idname, (ot)->srna, r_ptr)
132#define WM_toolsystem_ref_properties_ensure_from_gizmo_group(tref, gzgroup, r_ptr) \
133 WM_toolsystem_ref_properties_ensure_ex(tref, (gzgroup)->idname, (gzgroup)->srna, r_ptr)
134
135bool WM_toolsystem_ref_properties_get_ex(bToolRef *tref,
136 const char *idname,
137 StructRNA *type,
138 PointerRNA *r_ptr);
139#define WM_toolsystem_ref_properties_get_from_operator(tref, ot, r_ptr) \
140 WM_toolsystem_ref_properties_get_ex(tref, (ot)->idname, (ot)->srna, r_ptr)
141#define WM_toolsystem_ref_properties_get_from_gizmo_group(tref, gzgroup, r_ptr) \
142 WM_toolsystem_ref_properties_get_ex(tref, (gzgroup)->idname, (gzgroup)->srna, r_ptr)
143
145 PointerRNA *dst_ptr,
146 PointerRNA *src_ptr,
147 wmOperatorType *ot);
148
157void WM_toolsystem_refresh_active(bContext *C);
161bool WM_toolsystem_refresh_screen_area(const Main &bmain,
162 WorkSpace *workspace,
163 const Scene *scene,
164 ViewLayer *view_layer,
165 ScrArea *area);
166void WM_toolsystem_refresh_screen_window(const Main &bmain, wmWindow *win);
167void WM_toolsystem_refresh_screen_all(Main *bmain);
168
169} // namespace blender
#define C
Definition RandGen.cpp:29
Definition scene.h:133
BMesh Iterators.
void WM_toolsystem_refresh_active(bContext *C)
std::optional< AssetWeakReference > WM_toolsystem_last_brush_asset_from_brush_type(Scene *scene, const int brush_type, const PaintMode paint_mode)
void WM_toolsystem_refresh_all(const bContext *C, WorkSpace *workspace)
int WM_toolsystem_mode_from_spacetype(const Main &bmain, const Scene *scene, ViewLayer *view_layer, ScrArea *area, int space_type)
bToolRef_Runtime * WM_toolsystem_runtime_find(WorkSpace *workspace, const bToolKey *tkey)
bool WM_toolsystem_activate_brush_and_tool(bContext *C, Paint *paint, Brush *brush)
void WM_toolsystem_refresh(const bContext *C, WorkSpace *workspace, const bToolKey *tkey)
bToolRef * WM_toolsystem_ref_find(WorkSpace *workspace, const bToolKey *tkey)
bool WM_toolsystem_key_from_context(const Main &bmain, const Scene *scene, ViewLayer *view_layer, ScrArea *area, bToolKey *tkey)
bToolRef_Runtime * WM_toolsystem_runtime_from_context(const bContext *C)
void WM_toolsystem_ref_set_from_runtime(bContext *C, WorkSpace *workspace, bToolRef *tref, const bToolRef_Runtime *tref_rt, const char *idname)
void WM_toolsystem_refresh_screen_all(Main *bmain)
IDProperty * WM_toolsystem_ref_properties_get_idprops(bToolRef *tref)
void WM_toolsystem_do_msg_notify_tag_refresh(bContext *C, wmMsgSubscribeKey *, wmMsgSubscribeValue *msg_val)
void WM_toolsystem_ref_properties_ensure_ex(bToolRef *tref, const char *idname, StructRNA *type, PointerRNA *r_ptr)
void WM_toolsystem_init(const bContext *C)
void WM_toolsystem_update_from_context_view3d(bContext *C)
void WM_toolsystem_update_from_context(bContext *C, WorkSpace *workspace, const Scene *scene, ViewLayer *view_layer, ScrArea *area)
bToolRef * WM_toolsystem_ref_set_by_id(bContext *C, const char *name)
void WM_toolsystem_unlink(bContext *C, WorkSpace *workspace, const bToolKey *tkey)
bToolRef * WM_toolsystem_ref_set_by_id_ex(bContext *C, WorkSpace *workspace, const bToolKey *tkey, const char *name, bool cycle)
void WM_toolsystem_ref_properties_init_for_keymap(bToolRef *tref, PointerRNA *dst_ptr, PointerRNA *src_ptr, wmOperatorType *ot)
bool WM_toolsystem_active_tool_has_custom_cursor(const bContext *C)
bToolRef * WM_toolsystem_ref_from_context(const bContext *C)
bool WM_toolsystem_active_tool_is_brush(const bContext *C)
bool WM_toolsystem_refresh_screen_area(const Main &bmain, WorkSpace *workspace, const Scene *scene, ViewLayer *view_layer, ScrArea *area)
void WM_toolsystem_unlink_all(bContext *C, WorkSpace *workspace)
void WM_toolsystem_ref_sync_from_context(Main *bmain, WorkSpace *workspace, bToolRef *tref)
bool WM_toolsystem_ref_ensure(WorkSpace *workspace, const bToolKey *tkey, bToolRef **r_tref)
IDProperty * WM_toolsystem_ref_properties_ensure_idprops(bToolRef *tref)
void WM_toolsystem_reinit_all(bContext *C, wmWindow *win)
void WM_toolsystem_reinit(bContext *C, WorkSpace *workspace, const bToolKey *tkey)
bool WM_toolsystem_ref_properties_get_ex(bToolRef *tref, const char *idname, StructRNA *type, PointerRNA *r_ptr)
void WM_toolsystem_refresh_screen_window(const Main &bmain, wmWindow *win)