Blender V5.3
WM_toolsystem.hh File Reference
#include "BKE_paint_types.hh"

Go to the source code of this file.

Classes

struct  blender::bToolKey

Namespaces

namespace  blender
 BMesh Iterators.

Macros

#define WM_TOOLSYSTEM_SPACE_MASK   ((1 << SPACE_IMAGE) | (1 << SPACE_NODE) | (1 << SPACE_VIEW3D) | (1 << SPACE_SEQ))
#define WM_TOOLSYSTEM_SPACE_MASK_MODE_FROM_SPACE   ((1 << SPACE_IMAGE) | (1 << SPACE_SEQ))
#define WM_toolsystem_ref_properties_ensure_from_operator(tref, ot, r_ptr)
#define WM_toolsystem_ref_properties_ensure_from_gizmo_group(tref, gzgroup, r_ptr)
#define WM_toolsystem_ref_properties_get_from_operator(tref, ot, r_ptr)
#define WM_toolsystem_ref_properties_get_from_gizmo_group(tref, gzgroup, r_ptr)

Functions

bToolRef * blender::WM_toolsystem_ref_set_by_id_ex (bContext *C, WorkSpace *workspace, const bToolKey *tkey, const char *name, bool cycle)
bToolRef * blender::WM_toolsystem_ref_set_by_id (bContext *C, const char *name)
void blender::WM_toolsystem_unlink (bContext *C, WorkSpace *workspace, const bToolKey *tkey)
void blender::WM_toolsystem_refresh (const bContext *C, WorkSpace *workspace, const bToolKey *tkey)
void blender::WM_toolsystem_reinit (bContext *C, WorkSpace *workspace, const bToolKey *tkey)
void blender::WM_toolsystem_unlink_all (bContext *C, WorkSpace *workspace)
void blender::WM_toolsystem_refresh_all (const bContext *C, WorkSpace *workspace)
void blender::WM_toolsystem_reinit_all (bContext *C, wmWindow *win)
void blender::WM_toolsystem_ref_set_from_runtime (bContext *C, WorkSpace *workspace, bToolRef *tref, const bToolRef_Runtime *tref_rt, const char *idname)
void blender::WM_toolsystem_ref_sync_from_context (Main *bmain, WorkSpace *workspace, bToolRef *tref)
void blender::WM_toolsystem_init (const bContext *C)
int blender::WM_toolsystem_mode_from_spacetype (const Main &bmain, const Scene *scene, ViewLayer *view_layer, ScrArea *area, int space_type)
bool blender::WM_toolsystem_key_from_context (const Main &bmain, const Scene *scene, ViewLayer *view_layer, ScrArea *area, bToolKey *tkey)
void blender::WM_toolsystem_update_from_context_view3d (bContext *C)
void blender::WM_toolsystem_update_from_context (bContext *C, WorkSpace *workspace, const Scene *scene, ViewLayer *view_layer, ScrArea *area)
bool blender::WM_toolsystem_active_tool_is_brush (const bContext *C)
bool blender::WM_toolsystem_active_tool_has_custom_cursor (const bContext *C)
void blender::WM_toolsystem_do_msg_notify_tag_refresh (bContext *C, wmMsgSubscribeKey *, wmMsgSubscribeValue *msg_val)
IDProperty * blender::WM_toolsystem_ref_properties_get_idprops (bToolRef *tref)
IDProperty * blender::WM_toolsystem_ref_properties_ensure_idprops (bToolRef *tref)
void blender::WM_toolsystem_ref_properties_ensure_ex (bToolRef *tref, const char *idname, StructRNA *type, PointerRNA *r_ptr)
bool blender::WM_toolsystem_ref_properties_get_ex (bToolRef *tref, const char *idname, StructRNA *type, PointerRNA *r_ptr)
void blender::WM_toolsystem_ref_properties_init_for_keymap (bToolRef *tref, PointerRNA *dst_ptr, PointerRNA *src_ptr, wmOperatorType *ot)
void blender::WM_toolsystem_refresh_active (bContext *C)
bool blender::WM_toolsystem_refresh_screen_area (const Main &bmain, WorkSpace *workspace, const Scene *scene, ViewLayer *view_layer, ScrArea *area)
void blender::WM_toolsystem_refresh_screen_window (const Main &bmain, wmWindow *win)
void blender::WM_toolsystem_refresh_screen_all (Main *bmain)
Tool Reference API
bToolRef * blender::WM_toolsystem_ref_from_context (const bContext *C)
bToolRef * blender::WM_toolsystem_ref_find (WorkSpace *workspace, const bToolKey *tkey)
bool blender::WM_toolsystem_ref_ensure (WorkSpace *workspace, const bToolKey *tkey, bToolRef **r_tref)
bToolRef_Runtime * blender::WM_toolsystem_runtime_from_context (const bContext *C)
bToolRef_Runtime * blender::WM_toolsystem_runtime_find (WorkSpace *workspace, const bToolKey *tkey)
Brush Tools
bool blender::WM_toolsystem_activate_brush_and_tool (bContext *C, Paint *paint, Brush *brush)
std::optional< AssetWeakReference > blender::WM_toolsystem_last_brush_asset_from_brush_type (Scene *scene, const int brush_type, const PaintMode paint_mode)

Macro Definition Documentation

◆ WM_toolsystem_ref_properties_ensure_from_gizmo_group

#define WM_toolsystem_ref_properties_ensure_from_gizmo_group ( tref,
gzgroup,
r_ptr )
Value:
WM_toolsystem_ref_properties_ensure_ex(tref, (gzgroup)->idname, (gzgroup)->srna, r_ptr)

Definition at line 132 of file WM_toolsystem.hh.

Referenced by blender::ed::transform::gizmo_mesh_extrude_refresh(), blender::gizmo_mesh_spin_init_draw_prepare(), blender::gizmo_mesh_spin_init_refresh(), and blender::ed::transform::transform_from_gizmo_invoke().

◆ WM_toolsystem_ref_properties_ensure_from_operator

#define WM_toolsystem_ref_properties_ensure_from_operator ( tref,
ot,
r_ptr )
Value:
WM_toolsystem_ref_properties_ensure_ex(tref, (ot)->idname, (ot)->srna, r_ptr)

Definition at line 130 of file WM_toolsystem.hh.

◆ WM_toolsystem_ref_properties_get_from_gizmo_group

#define WM_toolsystem_ref_properties_get_from_gizmo_group ( tref,
gzgroup,
r_ptr )
Value:
WM_toolsystem_ref_properties_get_ex(tref, (gzgroup)->idname, (gzgroup)->srna, r_ptr)

Definition at line 141 of file WM_toolsystem.hh.

Referenced by blender::tool_generic_create_gizmo().

◆ WM_toolsystem_ref_properties_get_from_operator

#define WM_toolsystem_ref_properties_get_from_operator ( tref,
ot,
r_ptr )
Value:
WM_toolsystem_ref_properties_get_ex(tref, (ot)->idname, (ot)->srna, r_ptr)

Definition at line 139 of file WM_toolsystem.hh.

Referenced by blender::loopcut_tool_preview_cuts_from_toolsettings(), blender::ed::vse::split_tool_prop_from_toolsettings(), and blender::WM_gizmo_operator_invoke().

◆ WM_TOOLSYSTEM_SPACE_MASK

◆ WM_TOOLSYSTEM_SPACE_MASK_MODE_FROM_SPACE

#define WM_TOOLSYSTEM_SPACE_MASK_MODE_FROM_SPACE   ((1 << SPACE_IMAGE) | (1 << SPACE_SEQ))

Space-types that define their own "mode" (as returned by #WM_toolsystem_mode_from_spacetype).

Definition at line 40 of file WM_toolsystem.hh.

Referenced by blender::ED_area_newspace(), blender::toolsystem_ref_set_by_brush_type(), and blender::WM_toolsystem_ref_set_by_id_ex().