#include <cstring>
#include "CLG_log.h"
#include "MEM_guardedalloc.h"
#include "BLI_listbase.h"
#include "BLI_string.h"
#include "BLI_string_utf8.h"
#include "BLI_utildefines.h"
#include "DNA_ID.h"
#include "DNA_brush_types.h"
#include "DNA_object_types.h"
#include "DNA_scene_types.h"
#include "DNA_space_types.h"
#include "DNA_windowmanager_types.h"
#include "DNA_workspace_types.h"
#include "BKE_asset_edit.hh"
#include "BKE_brush.hh"
#include "BKE_context.hh"
#include "BKE_global.hh"
#include "BKE_idprop.hh"
#include "BKE_layer.hh"
#include "BKE_lib_id.hh"
#include "BKE_main.hh"
#include "BKE_paint.hh"
#include "BKE_paint_types.hh"
#include "BKE_workspace.hh"
#include "RNA_access.hh"
#include "RNA_enum_types.hh"
#include "WM_api.hh"
#include "WM_message.hh"
#include "WM_toolsystem.hh"
#include "WM_types.hh"

Functions
static void	toolsystem_reinit_with_toolref (bContext C, WorkSpace , bToolRef *tref)
static bToolRef *	toolsystem_reinit_ensure_toolref (bContext C, WorkSpace workspace, const bToolKey tkey, const char default_tool)
static void	toolsystem_refresh_screen_from_active_tool (Main bmain, WorkSpace workspace, bToolRef *tref)
static void	toolsystem_ref_set_by_brush_type (bContext C, const char brush_type)
static void	toolsystem_ref_set_by_id_pending (Main bmain, bToolRef tref, const char *idname_pending)
static void	toolsystem_unlink_ref (bContext C, WorkSpace , bToolRef *tref)
void	WM_toolsystem_unlink (bContext C, WorkSpace workspace, const bToolKey *tkey)
static void	toolsystem_ref_link (Main bmain, WorkSpace workspace, bToolRef *tref)
static void	toolsystem_refresh_ref (const bContext C, WorkSpace workspace, bToolRef *tref)
void	WM_toolsystem_refresh (const bContext C, WorkSpace workspace, const bToolKey *tkey)
static void	toolsystem_reinit_ref (bContext C, WorkSpace workspace, bToolRef *tref)
void	WM_toolsystem_reinit (bContext C, WorkSpace workspace, const bToolKey *tkey)
void	WM_toolsystem_unlink_all (bContext C, WorkSpace workspace)
void	WM_toolsystem_refresh_all (const bContext C, WorkSpace workspace)
void	WM_toolsystem_reinit_all (bContext C, wmWindow win)
void	WM_toolsystem_ref_set_from_runtime (bContext C, WorkSpace workspace, bToolRef tref, const bToolRef_Runtime tref_rt, const char *idname)
void	WM_toolsystem_ref_sync_from_context (Main bmain, WorkSpace workspace, bToolRef *tref)
void	WM_toolsystem_init (const bContext *C)
static bool	toolsystem_key_ensure_check (const bToolKey *tkey)
int	WM_toolsystem_mode_from_spacetype (const Scene scene, ViewLayer view_layer, ScrArea *area, int space_type)
bool	WM_toolsystem_key_from_context (const Scene scene, ViewLayer view_layer, ScrArea area, bToolKey tkey)
void	WM_toolsystem_refresh_active (bContext *C)
bool	WM_toolsystem_refresh_screen_area (WorkSpace workspace, const Scene scene, ViewLayer view_layer, ScrArea area)
void	WM_toolsystem_refresh_screen_window (wmWindow *win)
void	WM_toolsystem_refresh_screen_all (Main *bmain)
bToolRef *	WM_toolsystem_ref_set_by_id_ex (bContext C, WorkSpace workspace, const bToolKey tkey, const char name, bool cycle)
bToolRef *	WM_toolsystem_ref_set_by_id (bContext C, const char name)
static const char *	toolsystem_default_tool (const bToolKey *tkey)
static void	wm_toolsystem_update_from_context_view3d_impl (bContext C, WorkSpace workspace)
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)
bool	WM_toolsystem_active_tool_is_brush (const bContext *C)
bool	WM_toolsystem_active_tool_has_custom_cursor (const bContext *C)
void	WM_toolsystem_do_msg_notify_tag_refresh (bContext C, wmMsgSubscribeKey , wmMsgSubscribeValue *msg_val)
static IDProperty *	idprops_ensure_named_group (IDProperty group, const char idname)
IDProperty *	WM_toolsystem_ref_properties_get_idprops (bToolRef *tref)
IDProperty *	WM_toolsystem_ref_properties_ensure_idprops (bToolRef *tref)
bool	WM_toolsystem_ref_properties_get_ex (bToolRef tref, const char idname, StructRNA type, PointerRNA r_ptr)
void	WM_toolsystem_ref_properties_ensure_ex (bToolRef tref, const char idname, StructRNA type, PointerRNA r_ptr)
void	WM_toolsystem_ref_properties_init_for_keymap (bToolRef tref, PointerRNA dst_ptr, PointerRNA src_ptr, wmOperatorType ot)
Tool Reference API
bToolRef *	WM_toolsystem_ref_from_context (const bContext *C)
bToolRef_Runtime *	WM_toolsystem_runtime_from_context (const bContext *C)
bToolRef *	WM_toolsystem_ref_find (WorkSpace workspace, const bToolKey tkey)
bToolRef_Runtime *	WM_toolsystem_runtime_find (WorkSpace workspace, const bToolKey tkey)
bool	WM_toolsystem_ref_ensure (WorkSpace workspace, const bToolKey tkey, bToolRef **r_tref)
static bToolKey	toolsystem_key_from_context_or_view3d (const Scene scene, ViewLayer view_layer, ScrArea *area)
static const bToolRef *	toolsystem_active_tool_from_context_or_view3d (const bContext *C)
Brush Tools
static const char *	brush_type_identifier_get (const int brush_type, const PaintMode paint_mode)
static bool	brush_type_matches_active_tool (bContext *C, const int brush_type)
static NamedBrushAssetReference *	toolsystem_brush_type_binding_lookup (const Paint paint, const char brush_type_name)
static void	toolsystem_main_brush_binding_update_from_active (Paint *paint)
static void	toolsystem_brush_type_binding_update (Paint *paint, const PaintMode paint_mode, const int brush_type)
bool	WM_toolsystem_activate_brush_and_tool (bContext C, Paint paint, Brush *brush)
static void	toolsystem_brush_activate_from_toolref_for_object_particle (const Main bmain, const WorkSpace workspace, const bToolRef *tref)
static void	toolsystem_brush_activate_from_toolref_for_object_paint (Main bmain, const WorkSpace workspace, const bToolRef *tref)
static void	toolsystem_brush_activate_from_toolref (Main bmain, const WorkSpace workspace, const bToolRef *tref)
static void	toolsystem_brush_sync_for_texture_paint (Main bmain, WorkSpace workspace, bToolRef *tref)
static void	toolsystem_brush_clear_paint_reference (Main bmain, WorkSpace workspace, bToolRef *tref)

Detailed Description

Tool-system used to define tools in Blender's toolbar. See: ./scripts/startup/bl_ui/space_toolsystem_common.py, ToolDef for a detailed description of tool definitions.

Note: Tools are stored per workspace. Notice many functions take Main & WorkSpace and not window/screen/scene data. This is intentional as changing tools must account for all scenes using that workspace. Functions that refreshes on tool change are responsible for updating all windows using this workspace.

Definition in file wm_toolsystem.cc.

Function Documentation

◆ brush_type_identifier_get()

const char * brush_type_identifier_get	(	const int	brush_type,
		const PaintMode	paint_mode )

static

Definition at line 212 of file wm_toolsystem.cc.

References BKE_paint_get_tool_enum_from_paintmode(), EnumPropertyItem::identifier, and RNA_enum_from_value().

Referenced by toolsystem_brush_activate_from_toolref_for_object_paint(), toolsystem_brush_type_binding_update(), and WM_toolsystem_activate_brush_and_tool().

◆ brush_type_matches_active_tool()

bool brush_type_matches_active_tool	(	bContext *	C,
		const int	brush_type )

static

Definition at line 222 of file wm_toolsystem.cc.

References BKE_paintmode_get_active_from_context(), BKE_paintmode_get_from_tool(), BLI_assert, bToolRef_Runtime::brush_type, C, bToolRef_Runtime::flag, G, bToolRef::runtime, TOOLREF_FLAG_USE_BRUSHES, and toolsystem_active_tool_from_context_or_view3d().

Referenced by WM_toolsystem_activate_brush_and_tool().

◆ idprops_ensure_named_group()

IDProperty * idprops_ensure_named_group	(	IDProperty *	group,
		const char *	idname )

static

Definition at line 1270 of file wm_toolsystem.cc.

References blender::bke::idprop::create_group(), IDP_GetPropertyFromGroup(), IDP_GROUP, IDP_ReplaceInGroup_ex(), IDProperty::name, STRNCPY_UTF8, and IDProperty::type.

Referenced by WM_toolsystem_ref_properties_ensure_ex(), and WM_toolsystem_ref_properties_ensure_idprops().

◆ toolsystem_active_tool_from_context_or_view3d()

const bToolRef * toolsystem_active_tool_from_context_or_view3d ( const bContext * C )

static

Get the active tool for the current context (space and mode) if the current space supports tools or, fallback to the active tool of the 3D View in the current mode.

Use this instead of WM_toolsystem_ref_from_context() when usage from properties editors should be possible, which shows tool settings of the 3D View.

Definition at line 165 of file wm_toolsystem.cc.

References C, CTX_data_scene(), CTX_data_view_layer(), CTX_wm_area(), CTX_wm_workspace(), bToolKey::mode, bToolKey::space_type, SPACE_VIEW3D, ScrArea::spacetype, WM_toolsystem_mode_from_spacetype(), WM_toolsystem_ref_find(), WM_toolsystem_ref_from_context(), and WM_TOOLSYSTEM_SPACE_MASK.

Referenced by brush_type_matches_active_tool(), and WM_toolsystem_activate_brush_and_tool().

◆ toolsystem_brush_activate_from_toolref()

void toolsystem_brush_activate_from_toolref	(	Main *	bmain,
		const WorkSpace *	workspace,
		const bToolRef *	tref )

static

Activate a brush compatible with tref, call when the active tool changes.

Definition at line 431 of file wm_toolsystem.cc.

References BLI_assert, CTX_MODE_PARTICLE, bToolRef_Runtime::flag, bToolRef::mode, bToolRef::runtime, SI_MODE_PAINT, SPACE_IMAGE, bToolRef::space_type, SPACE_VIEW3D, TOOLREF_FLAG_USE_BRUSHES, toolsystem_brush_activate_from_toolref_for_object_paint(), and toolsystem_brush_activate_from_toolref_for_object_particle().

Referenced by toolsystem_ref_link().

◆ toolsystem_brush_activate_from_toolref_for_object_paint()

void toolsystem_brush_activate_from_toolref_for_object_paint	(	Main *	bmain,
		const WorkSpace *	workspace,
		const bToolRef *	tref )

static

◆ toolsystem_brush_activate_from_toolref_for_object_particle()

void toolsystem_brush_activate_from_toolref_for_object_particle	(	const Main *	bmain,
		const WorkSpace *	workspace,
		const bToolRef *	tref )

static

Definition at line 339 of file wm_toolsystem.cc.

References ParticleEditSettings::brushtype, bToolRef_Runtime::data_block, ListBase::first, i, LISTBASE_FOREACH, ToolSettings::particle, RNA_enum_from_identifier(), rna_enum_particle_edit_hair_brush_items, bToolRef::runtime, Scene::toolsettings, EnumPropertyItem::value, wmWindowManager::windows, Main::wm, WM_window_get_active_scene(), and WM_window_get_active_workspace().

Referenced by toolsystem_brush_activate_from_toolref().

◆ toolsystem_brush_clear_paint_reference()

void toolsystem_brush_clear_paint_reference	(	Main *	bmain,
		WorkSpace *	workspace,
		bToolRef *	tref )

static

Definition at line 484 of file wm_toolsystem.cc.

References BKE_paint_get_active_from_paintmode(), BKE_paint_previous_asset_reference_clear(), BKE_paintmode_get_from_tool(), ListBase::first, LISTBASE_FOREACH, wmWindowManager::windows, Main::wm, WM_window_get_active_scene(), and WM_window_get_active_workspace().

Referenced by toolsystem_ref_link().

◆ toolsystem_brush_sync_for_texture_paint()

void toolsystem_brush_sync_for_texture_paint	(	Main *	bmain,
		WorkSpace *	workspace,
		bToolRef *	tref )

static

Special case, the active brush data-block for the image & 3D viewport are shared. This means changing the active brush tool in one space must change the tool for the other space as well, see: #131062.

Definition at line 457 of file wm_toolsystem.cc.

References CTX_MODE_PAINT_TEXTURE, bToolRef::idname, bToolKey::mode, bToolRef::mode, SI_MODE_PAINT, SPACE_IMAGE, bToolKey::space_type, bToolRef::space_type, SPACE_VIEW3D, toolsystem_ref_set_by_id_pending(), and WM_toolsystem_ref_find().

Referenced by toolsystem_ref_link().

◆ toolsystem_brush_type_binding_lookup()

NamedBrushAssetReference * toolsystem_brush_type_binding_lookup	(	const Paint *	paint,
		const char *	brush_type_name )

static

Definition at line 240 of file wm_toolsystem.cc.

References ToolSystemBrushBindings::active_brush_per_brush_type, BLI_findstring_ptr(), name, offsetof, and Paint::tool_brush_bindings.

Referenced by toolsystem_brush_activate_from_toolref_for_object_paint(), and toolsystem_brush_type_binding_update().

◆ toolsystem_brush_type_binding_update()

void toolsystem_brush_type_binding_update	(	Paint *	paint,
		const PaintMode	paint_mode,
		const int	brush_type )

static

Definition at line 267 of file wm_toolsystem.cc.

References ToolSystemBrushBindings::active_brush_per_brush_type, BLI_addhead(), BLI_strdup(), Paint::brush, NamedBrushAssetReference::brush_asset_reference, Paint::brush_asset_reference, brush_type_identifier_get(), MEM_callocN(), NamedBrushAssetReference::name, Paint::tool_brush_bindings, and toolsystem_brush_type_binding_lookup().

Referenced by WM_toolsystem_activate_brush_and_tool().

◆ toolsystem_default_tool()

const char * toolsystem_default_tool ( const bToolKey * tkey )

static

◆ toolsystem_key_ensure_check()

bool toolsystem_key_ensure_check ( const bToolKey * tkey )

static

Definition at line 724 of file wm_toolsystem.cc.

References ELEM, bToolKey::mode, SI_MODE_MASK, SI_MODE_PAINT, SI_MODE_UV, SI_MODE_VIEW, SPACE_IMAGE, SPACE_NODE, SPACE_SEQ, bToolKey::space_type, and SPACE_VIEW3D.

Referenced by WM_toolsystem_update_from_context().

◆ toolsystem_key_from_context_or_view3d()

bToolKey toolsystem_key_from_context_or_view3d	(	const Scene *	scene,
		ViewLayer *	view_layer,
		ScrArea *	area )

static

Similar to toolsystem_active_tool_from_context_or_view3d(), but returns the tool key only.

Definition at line 140 of file wm_toolsystem.cc.

References bToolKey::mode, bToolKey::space_type, SPACE_VIEW3D, ScrArea::spacetype, WM_toolsystem_mode_from_spacetype(), and WM_TOOLSYSTEM_SPACE_MASK.

Referenced by toolsystem_ref_set_by_brush_type().

◆ toolsystem_main_brush_binding_update_from_active()

void toolsystem_main_brush_binding_update_from_active ( Paint * paint )

static

Update the bindings so the main brush reference matches the currently active brush.

Definition at line 252 of file wm_toolsystem.cc.

References blender::bke::asset_edit_weak_reference_from_id(), Paint::brush, Brush::id, ToolSystemBrushBindings::main_brush_asset_reference, and Paint::tool_brush_bindings.

Referenced by toolsystem_brush_activate_from_toolref_for_object_paint(), and WM_toolsystem_activate_brush_and_tool().

◆ toolsystem_ref_link()

void toolsystem_ref_link	(	Main *	bmain,
		WorkSpace *	workspace,
		bToolRef *	tref )

static

◆ toolsystem_ref_set_by_brush_type()

void toolsystem_ref_set_by_brush_type	(	bContext *	C,
		const char *	brush_type )

static

◆ toolsystem_ref_set_by_id_pending()

void toolsystem_ref_set_by_id_pending	(	Main *	bmain,
		bToolRef *	tref,
		const char *	idname_pending )

static

Request a tool ID be activated in a context where it's not known if the tool exists, when the areas using this tool are not visible. In this case, set the idname as pending and flag tools area for updating.

If the tool doesn't exist then the current tool is to be left as-is.

Definition at line 1056 of file wm_toolsystem.cc.

References AREA_FLAG_ACTIVE_TOOL_UPDATE, BLI_assert, bToolRef::idname, bToolRef::idname_pending, LISTBASE_FOREACH, Main::screens, STREQ, and STRNCPY_UTF8.

Referenced by toolsystem_brush_sync_for_texture_paint().

◆ toolsystem_refresh_ref()

void toolsystem_refresh_ref	(	const bContext *	C,
		WorkSpace *	workspace,
		bToolRef *	tref )

static

Definition at line 534 of file wm_toolsystem.cc.

References C, CTX_data_main(), bToolRef::runtime, and toolsystem_ref_link().

Referenced by WM_toolsystem_refresh(), WM_toolsystem_refresh_active(), and WM_toolsystem_refresh_all().

◆ toolsystem_refresh_screen_from_active_tool()

void toolsystem_refresh_screen_from_active_tool	(	Main *	bmain,
		WorkSpace *	workspace,
		bToolRef *	tref )

static

Definition at line 925 of file wm_toolsystem.cc.

References bScreen::areabase, ListBase::first, LISTBASE_FOREACH, bToolRef::mode, bToolRef::runtime, bToolRef::space_type, Main::wm, WM_toolsystem_mode_from_spacetype(), WM_window_get_active_scene(), WM_window_get_active_screen(), WM_window_get_active_view_layer(), and WM_window_get_active_workspace().

Referenced by toolsystem_ref_set_by_brush_type(), WM_toolsystem_ref_set_by_id_ex(), and WM_toolsystem_ref_set_from_runtime().

◆ toolsystem_reinit_ensure_toolref()

bToolRef * toolsystem_reinit_ensure_toolref	(	bContext *	C,
		WorkSpace *	workspace,
		const bToolKey *	tkey,
		const char *	default_tool )

static

Run after changing modes.

Definition at line 1160 of file wm_toolsystem.cc.

References C, bToolRef::idname, STRNCPY_UTF8, toolsystem_default_tool(), toolsystem_reinit_with_toolref(), and WM_toolsystem_ref_ensure().

Referenced by WM_toolsystem_refresh_active(), WM_toolsystem_update_from_context(), and wm_toolsystem_update_from_context_view3d_impl().

◆ toolsystem_reinit_ref()

void toolsystem_reinit_ref	(	bContext *	C,
		WorkSpace *	workspace,
		bToolRef *	tref )

static

Definition at line 550 of file wm_toolsystem.cc.

References C, and toolsystem_reinit_with_toolref().

Referenced by WM_toolsystem_reinit(), and WM_toolsystem_reinit_all().

◆ toolsystem_reinit_with_toolref()

void toolsystem_reinit_with_toolref	(	bContext *	C,
		WorkSpace *	workspace,
		bToolRef *	tref )

static

Definition at line 1097 of file wm_toolsystem.cc.

References C, bToolRef::idname, bToolRef::idname_pending, bToolKey::mode, bToolRef::mode, bToolKey::space_type, bToolRef::space_type, and WM_toolsystem_ref_set_by_id_ex().

Referenced by toolsystem_reinit_ensure_toolref(), and toolsystem_reinit_ref().

◆ toolsystem_unlink_ref()

void toolsystem_unlink_ref	(	bContext *	C,
		WorkSpace *	,
		bToolRef *	tref )

static

Definition at line 188 of file wm_toolsystem.cc.

References C, CTX_data_main(), bToolRef_Runtime::gizmo_group, bToolRef::runtime, WM_gizmo_group_remove_by_tool(), and WM_gizmogrouptype_find().

Referenced by WM_toolsystem_ref_set_from_runtime(), WM_toolsystem_unlink(), and WM_toolsystem_unlink_all().

◆ WM_toolsystem_activate_brush_and_tool()

bool WM_toolsystem_activate_brush_and_tool	(	bContext *	C,
		Paint *	paint,
		Brush *	brush )

Activate the brush through the tool system. This will call BKE_paint_brush_set() with brush, but it will also switch to the tool appropriate for this brush type (if necessary) and update the current tool-brush references to remember the last used brush for that tool.

Returns: True if the brush was successfully activated.

Definition at line 298 of file wm_toolsystem.cc.

References BKE_paint_brush_set(), BKE_paint_can_use_brush(), BKE_paint_get_brush_type_from_paintmode(), BKE_paintmode_get_active_from_context(), BLI_assert_unreachable, bToolRef_Runtime::brush_type, brush_type_identifier_get(), brush_type_matches_active_tool(), C, bToolRef::runtime, toolsystem_active_tool_from_context_or_view3d(), toolsystem_brush_type_binding_update(), toolsystem_main_brush_binding_update_from_active(), toolsystem_ref_set_by_brush_type(), and WM_toolsystem_ref_set_by_id().

Referenced by blender::ed::sculpt_paint::brush_asset_activate_exec(), and blender::ed::sculpt_paint::brush_asset_save_as_exec().

◆ WM_toolsystem_active_tool_has_custom_cursor()

bool WM_toolsystem_active_tool_has_custom_cursor ( const bContext * C )

Definition at line 1237 of file wm_toolsystem.cc.

References C, bToolRef_Runtime::cursor, WM_CURSOR_DEFAULT, and WM_toolsystem_runtime_from_context().

Referenced by blender::ed::greasepencil::brush_cursor_poll().

◆ WM_toolsystem_active_tool_is_brush()

bool WM_toolsystem_active_tool_is_brush ( const bContext * C )

For paint modes to support non-brush tools.

Definition at line 1231 of file wm_toolsystem.cc.

References C, bToolRef_Runtime::flag, TOOLREF_FLAG_USE_BRUSHES, and WM_toolsystem_runtime_from_context().

Referenced by blender::ed::greasepencil::brush_cursor_poll(), brush_drawcursor(), brush_edit_poll(), blender::ed::sculpt_paint::grease_pencil_brush_stroke_poll(), blender::ed::greasepencil::grease_pencil_poll_vertex_cursor(), blender::ed::greasepencil::grease_pencil_poll_weight_cursor(), blender::ed::sculpt_paint::grease_pencil_sculpt_paint_poll(), blender::ed::sculpt_paint::grease_pencil_vertex_brush_stroke_poll(), blender::ed::sculpt_paint::grease_pencil_weight_brush_stroke_poll(), image_paint_poll_ex(), blender::ed::greasepencil::keymap_grease_pencil_brush_stroke_poll(), blender::ed::greasepencil::keymap_grease_pencil_fill_tool_poll(), blender::ed::sculpt_paint::paint_draw_tex_overlay(), vertex_paint_poll_ex(), and weight_paint_poll_ex().

◆ WM_toolsystem_do_msg_notify_tag_refresh()

void WM_toolsystem_do_msg_notify_tag_refresh	(	bContext *	C,
		wmMsgSubscribeKey *	msg_key,
		wmMsgSubscribeValue *	msg_val )

◆ WM_toolsystem_init()

void WM_toolsystem_init ( const bContext * C )

Definition at line 709 of file wm_toolsystem.cc.

References BLI_assert, C, CTX_data_main(), CTX_wm_window(), LISTBASE_FOREACH, MEM_SAFE_FREE, and Main::workspaces.

Referenced by wm_file_read_post().

◆ WM_toolsystem_key_from_context()

bool WM_toolsystem_key_from_context	(	const Scene *	scene,
		ViewLayer *	view_layer,
		ScrArea *	area,
		bToolKey *	tkey )

Definition at line 780 of file wm_toolsystem.cc.

References bToolKey::mode, SPACE_EMPTY, bToolKey::space_type, ScrArea::spacetype, and WM_toolsystem_mode_from_spacetype().

Referenced by WM_toolsystem_ref_set_by_id().

◆ WM_toolsystem_mode_from_spacetype()

int WM_toolsystem_mode_from_spacetype	(	const Scene *	scene,
		ViewLayer *	view_layer,
		ScrArea *	area,
		int	space_type )

◆ WM_toolsystem_ref_ensure()

bool WM_toolsystem_ref_ensure	(	WorkSpace *	workspace,
		const bToolKey *	tkey,
		bToolRef **	r_tref )

Definition at line 122 of file wm_toolsystem.cc.

References BLI_addhead(), MEM_callocN(), bToolKey::mode, bToolRef::mode, bToolKey::space_type, bToolRef::space_type, WorkSpace::tools, and WM_toolsystem_ref_find().

Referenced by toolsystem_reinit_ensure_toolref().

◆ WM_toolsystem_ref_find()

bToolRef * WM_toolsystem_ref_find	(	WorkSpace *	workspace,
		const bToolKey *	tkey )

◆ WM_toolsystem_ref_from_context()

bToolRef * WM_toolsystem_ref_from_context ( const bContext * C )

Definition at line 76 of file wm_toolsystem.cc.

References BLI_assert, C, CTX_data_scene(), CTX_data_view_layer(), CTX_wm_area(), CTX_wm_workspace(), ScrArea_Runtime::is_tool_set, bToolKey::mode, ScrArea::runtime, bToolKey::space_type, ScrArea::spacetype, ScrArea_Runtime::tool, WM_toolsystem_mode_from_spacetype(), WM_toolsystem_ref_find(), and WM_TOOLSYSTEM_SPACE_MASK.

Referenced by ED_image_paint_brush_type_update_sticky_shading_color(), ED_image_paint_brush_type_use_canvas(), blender::ed::transform::gizmo_mesh_extrude_refresh(), gizmo_mesh_spin_init_draw_prepare(), gizmo_mesh_spin_init_refresh(), image_paint_brush_type_shading_color_follows_last_used_tool(), blender::ed::greasepencil::keymap_grease_pencil_brush_stroke_poll(), tool_generic_create_gizmo(), toolsystem_active_tool_from_context_or_view3d(), blender::ed::transform::transform_from_gizmo_invoke(), WM_gizmo_operator_invoke(), wm_handler_operator_call(), and WM_toolsystem_runtime_from_context().

◆ WM_toolsystem_ref_properties_ensure_ex()

void WM_toolsystem_ref_properties_ensure_ex	(	bToolRef *	tref,
		const char *	idname,
		StructRNA *	type,
		PointerRNA *	r_ptr )

Definition at line 1309 of file wm_toolsystem.cc.

References idprops_ensure_named_group(), RNA_pointer_create_discrete(), and WM_toolsystem_ref_properties_ensure_idprops().

◆ WM_toolsystem_ref_properties_ensure_idprops()

IDProperty * WM_toolsystem_ref_properties_ensure_idprops ( bToolRef * tref )

Definition at line 1290 of file wm_toolsystem.cc.

References blender::bke::idprop::create_group(), bToolRef::idname, idprops_ensure_named_group(), and bToolRef::properties.

Referenced by WM_toolsystem_ref_properties_ensure_ex().

◆ WM_toolsystem_ref_properties_get_ex()

bool WM_toolsystem_ref_properties_get_ex	(	bToolRef *	tref,
		const char *	idname,
		StructRNA *	type,
		PointerRNA *	r_ptr )

Definition at line 1298 of file wm_toolsystem.cc.

References IDP_GetPropertyFromGroup(), RNA_pointer_create_discrete(), and WM_toolsystem_ref_properties_get_idprops().

◆ WM_toolsystem_ref_properties_get_idprops()

IDProperty * WM_toolsystem_ref_properties_get_idprops ( bToolRef * tref )

Definition at line 1281 of file wm_toolsystem.cc.

References bToolRef::idname, IDP_GetPropertyFromGroup(), and bToolRef::properties.

Referenced by WM_toolsystem_ref_properties_get_ex(), and WM_toolsystem_ref_properties_init_for_keymap().

◆ WM_toolsystem_ref_properties_init_for_keymap()

void WM_toolsystem_ref_properties_init_for_keymap	(	bToolRef *	tref,
		PointerRNA *	dst_ptr,
		PointerRNA *	src_ptr,
		wmOperatorType *	ot )

Definition at line 1319 of file wm_toolsystem.cc.

References blender::bke::idprop::create_group(), PointerRNA::data, IDP_CopyProperty(), IDP_GetPropertyFromGroup(), IDP_MergeGroup(), ot, and WM_toolsystem_ref_properties_get_idprops().

Referenced by view3d_interactive_add_modal(), and wm_handler_operator_call().

◆ WM_toolsystem_ref_set_by_id()

bToolRef * WM_toolsystem_ref_set_by_id	(	bContext *	C,
		const char *	name )

Definition at line 993 of file wm_toolsystem.cc.

References C, CTX_data_scene(), CTX_data_view_layer(), CTX_wm_area(), CTX_wm_workspace(), name, WM_toolsystem_key_from_context(), and WM_toolsystem_ref_set_by_id_ex().

Referenced by WM_toolsystem_activate_brush_and_tool().

◆ WM_toolsystem_ref_set_by_id_ex()

bToolRef * WM_toolsystem_ref_set_by_id_ex	(	bContext *	C,
		WorkSpace *	workspace,
		const bToolKey *	tkey,
		const char *	name,
		bool	cycle )

◆ WM_toolsystem_ref_set_from_runtime()

void WM_toolsystem_ref_set_from_runtime	(	bContext *	C,
		WorkSpace *	workspace,
		bToolRef *	tref,
		const bToolRef_Runtime *	tref_rt,
		const char *	idname )

◆ WM_toolsystem_ref_sync_from_context()

void WM_toolsystem_ref_sync_from_context	(	Main *	bmain,
		WorkSpace *	workspace,
		bToolRef *	tref )

Sync the internal active state of a tool back into the tool system, this is needed for active brushes where the real active state is not stored in the tool system.