Classes
struct	bToolKey

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) WM_toolsystem_ref_properties_ensure_ex(tref, (ot)->idname, (ot)->srna, r_ptr)

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

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

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

Functions
bToolRef *	WM_toolsystem_ref_from_context (const bContext *C)

bToolRef *	WM_toolsystem_ref_find (WorkSpace workspace, const bToolKey tkey)

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

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)

bToolRef_Runtime *	WM_toolsystem_runtime_from_context (const bContext *C)

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_unlink (bContext C, WorkSpace workspace, const bToolKey *tkey)

void	WM_toolsystem_refresh (const bContext C, WorkSpace workspace, const bToolKey *tkey)

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)

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_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 msg_key, wmMsgSubscribeValue *msg_val)

IDProperty *	WM_toolsystem_ref_properties_get_idprops (bToolRef *tref)

IDProperty *	WM_toolsystem_ref_properties_ensure_idprops (bToolRef *tref)

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

bool	WM_toolsystem_ref_properties_get_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)

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)

Macro Definition Documentation

◆ WM_toolsystem_ref_properties_ensure_from_gizmo_group

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

Definition at line 123 of file WM_toolsystem.hh.

Referenced by gizmo_mesh_extrude_refresh(), gizmo_mesh_spin_init_draw_prepare(), gizmo_mesh_spin_init_refresh(), and transform_from_gizmo_invoke().

◆ WM_toolsystem_ref_properties_ensure_from_operator

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

Definition at line 121 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 ) WM_toolsystem_ref_properties_get_ex(tref, (gzgroup)->idname, (gzgroup)->srna, r_ptr)

Definition at line 132 of file WM_toolsystem.hh.

Referenced by tool_generic_create_gizmo().

◆ WM_toolsystem_ref_properties_get_from_operator

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

Definition at line 130 of file WM_toolsystem.hh.

Referenced by WM_gizmo_operator_invoke().

◆ WM_TOOLSYSTEM_SPACE_MASK

#define WM_TOOLSYSTEM_SPACE_MASK ((1 << SPACE_IMAGE) | (1 << SPACE_NODE) | (1 << SPACE_VIEW3D) | (1 << SPACE_SEQ))

Definition at line 30 of file WM_toolsystem.hh.

Referenced by ED_area_init(), toolsystem_active_tool_from_context_or_view3d(), toolsystem_key_from_context_or_view3d(), toolsystem_ref_set_by_brush_type(), wm_draw_window_offscreen(), WM_toolsystem_ref_find(), WM_toolsystem_ref_from_context(), WM_toolsystem_ref_set_by_id_ex(), WM_toolsystem_refresh_active(), WM_toolsystem_reinit_all(), and WM_window_cursor_keymap_status_refresh().

◆ 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 35 of file WM_toolsystem.hh.

Referenced by toolsystem_ref_set_by_brush_type(), and WM_toolsystem_ref_set_by_id_ex().

Function Documentation

◆ 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 277 of file wm_toolsystem.cc.

References BKE_paint_brush_poll(), BKE_paint_brush_set(), 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(), 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 1099 of file wm_toolsystem.cc.

References 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 1093 of file wm_toolsystem.cc.

References 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(), 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 )

Follow wmMsgNotifyFn spec.

Definition at line 1105 of file wm_toolsystem.cc.

References BLI_findindex(), CTX_data_main(), ListBase::first, wmWindow::next, bToolKey::space_type, wmMsgSubscribeValue::user_data, Main::wm, WM_toolsystem_mode_from_spacetype(), WM_toolsystem_refresh(), WM_toolsystem_refresh_screen_area(), WM_window_get_active_scene(), WM_window_get_active_screen(), WM_window_get_active_view_layer(), and WM_window_get_active_workspace().

Referenced by view3d_main_region_message_subscribe().

◆ WM_toolsystem_init()

void WM_toolsystem_init ( const bContext * C )

Definition at line 629 of file wm_toolsystem.cc.

References BLI_assert, 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 700 of file wm_toolsystem.cc.

References bToolKey::mode, SPACE_EMPTY, bToolKey::space_type, 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 107 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 )

◆ 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 1171 of file wm_toolsystem.cc.

References idprops_ensure_named_group(), RNA_pointer_create(), 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 1152 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 1160 of file wm_toolsystem.cc.

References IDP_GetPropertyFromGroup(), RNA_pointer_create(), 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 1143 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 1181 of file wm_toolsystem.cc.

References blender::bke::idprop::create_group(), PointerRNA::data, wmOperatorType::idname, 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 913 of file wm_toolsystem.cc.

References CTX_data_scene(), CTX_data_view_layer(), CTX_wm_area(), CTX_wm_workspace(), 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.