|
Blender V5.0
|
Go to the source code of this file.
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) |
| #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) |
| #define WM_toolsystem_ref_properties_ensure_from_gizmo_group | ( | tref, | |
| gzgroup, | |||
| r_ptr ) |
Definition at line 125 of file WM_toolsystem.hh.
Referenced by blender::ed::transform::gizmo_mesh_extrude_refresh(), gizmo_mesh_spin_init_draw_prepare(), gizmo_mesh_spin_init_refresh(), and blender::ed::transform::transform_from_gizmo_invoke().
| #define WM_toolsystem_ref_properties_ensure_from_operator | ( | tref, | |
| ot, | |||
| r_ptr ) |
Definition at line 123 of file WM_toolsystem.hh.
| #define WM_toolsystem_ref_properties_get_from_gizmo_group | ( | tref, | |
| gzgroup, | |||
| r_ptr ) |
Definition at line 134 of file WM_toolsystem.hh.
Referenced by tool_generic_create_gizmo().
| #define WM_toolsystem_ref_properties_get_from_operator | ( | tref, | |
| ot, | |||
| r_ptr ) |
| #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_area_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().
| #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().
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.
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().
| 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().
| 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().
| void WM_toolsystem_do_msg_notify_tag_refresh | ( | bContext * | C, |
| wmMsgSubscribeKey * | msg_key, | ||
| wmMsgSubscribeValue * | msg_val ) |
Follow wmMsgNotifyFn spec.
Definition at line 1243 of file wm_toolsystem.cc.
References bScreen::areabase, BLI_findindex(), C, CTX_data_main(), ListBase::first, bToolKey::mode, wmWindow::next, bToolKey::space_type, ScrArea::spacetype, 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().
| 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().
| 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().
| int WM_toolsystem_mode_from_spacetype | ( | const Scene * | scene, |
| ViewLayer * | view_layer, | ||
| ScrArea * | area, | ||
| int | space_type ) |
Definition at line 742 of file wm_toolsystem.cc.
References BKE_view_layer_active_object_get(), BKE_view_layer_synced_ensure(), CTX_data_mode_enum_ex(), CTX_MODE_OBJECT, ListBase::first, Object::mode, SpaceImage::mode, OBEDIT_FROM_OBACT, SPACE_IMAGE, SPACE_NODE, SPACE_SEQ, SPACE_VIEW3D, ScrArea::spacedata, and SpaceSeq::view.
Referenced by toolsystem_active_tool_from_context_or_view3d(), toolsystem_key_from_context_or_view3d(), toolsystem_refresh_screen_from_active_tool(), WM_toolsystem_do_msg_notify_tag_refresh(), WM_toolsystem_key_from_context(), WM_toolsystem_ref_from_context(), WM_toolsystem_refresh_active(), WM_toolsystem_refresh_screen_area(), WM_toolsystem_reinit_all(), WM_toolsystem_update_from_context(), wm_toolsystem_update_from_context_view3d_impl(), and WM_window_cursor_keymap_status_refresh().
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().
Definition at line 105 of file wm_toolsystem.cc.
References BLI_assert, LISTBASE_FOREACH, bToolKey::mode, bToolKey::space_type, WorkSpace::tools, and WM_TOOLSYSTEM_SPACE_MASK.
Referenced by toolsystem_active_tool_from_context_or_view3d(), toolsystem_brush_sync_for_texture_paint(), toolsystem_ref_set_by_brush_type(), WM_toolsystem_ref_ensure(), WM_toolsystem_ref_from_context(), WM_toolsystem_ref_set_by_id_ex(), WM_toolsystem_refresh(), WM_toolsystem_refresh_active(), WM_toolsystem_reinit(), WM_toolsystem_reinit_all(), WM_toolsystem_runtime_find(), WM_toolsystem_unlink(), and WM_window_cursor_keymap_status_refresh().
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().
| 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().
| 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().
| 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().
| 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().
| 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().
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().
| bToolRef * WM_toolsystem_ref_set_by_id_ex | ( | bContext * | C, |
| WorkSpace * | workspace, | ||
| const bToolKey * | tkey, | ||
| const char * | name, | ||
| bool | cycle ) |
Definition at line 952 of file wm_toolsystem.cc.
References BLI_assert, C, CTX_data_main(), CTX_wm_area(), blender::wm::ExecDefault, bToolRef::idname, name, ot, RNA_boolean_set(), RNA_enum_set(), RNA_string_set(), bToolKey::space_type, ScrArea::spacetype, STREQ, toolsystem_refresh_screen_from_active_tool(), WM_operator_name_call_ptr(), WM_operator_properties_create_ptr(), WM_operator_properties_free(), WM_operatortype_find(), WM_toolsystem_ref_find(), WM_TOOLSYSTEM_SPACE_MASK, and WM_TOOLSYSTEM_SPACE_MASK_MODE_FROM_SPACE.
Referenced by toolsystem_reinit_with_toolref(), and WM_toolsystem_ref_set_by_id().
| void WM_toolsystem_ref_set_from_runtime | ( | bContext * | C, |
| WorkSpace * | workspace, | ||
| bToolRef * | tref, | ||
| const bToolRef_Runtime * | tref_rt, | ||
| const char * | idname ) |
Definition at line 609 of file wm_toolsystem.cc.
References wmWindow::addmousemove, C, CTX_data_main(), CTX_wm_message_bus(), CTX_wm_window(), bToolRef_Runtime::flag, wmGizmoGroupType::flag, bToolRef_Runtime::gizmo_group, WorkSpace::id, bToolRef::idname, bToolRef::idname_fallback, bToolRef::idname_pending, bToolRef_Runtime::keymap_fallback, MEM_callocN(), bToolRef::runtime, STRNCPY_UTF8, wmWindow::tag_cursor_refresh, TOOLREF_FLAG_FALLBACK_KEYMAP, toolsystem_ref_link(), toolsystem_refresh_screen_from_active_tool(), toolsystem_unlink_ref(), WM_gizmogrouptype_find(), WM_GIZMOGROUPTYPE_TOOL_FALLBACK_KEYMAP, and WM_msg_publish_rna_prop.
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.
Definition at line 675 of file wm_toolsystem.cc.
References BKE_view_layer_active_object_get(), BKE_view_layer_synced_ensure(), ParticleEditSettings::brushtype, CTX_MODE_PARTICLE, bToolRef_Runtime::data_block, ListBase::first, i, EnumPropertyItem::identifier, bToolRef::idname, LISTBASE_FOREACH, bToolRef::mode, Object::mode, EnumPropertyItem::name, OB_MODE_PARTICLE_EDIT, ToolSettings::particle, RNA_enum_from_value(), rna_enum_particle_edit_hair_brush_items, bToolRef::runtime, SNPRINTF_UTF8, bToolRef::space_type, SPACE_VIEW3D, STREQ, STRNCPY_UTF8, Scene::toolsettings, wmWindowManager::windows, Main::wm, WM_window_get_active_scene(), WM_window_get_active_view_layer(), and WM_window_get_active_workspace().
Definition at line 542 of file wm_toolsystem.cc.
References C, toolsystem_refresh_ref(), and WM_toolsystem_ref_find().
Referenced by WM_toolsystem_do_msg_notify_tag_refresh().
| void WM_toolsystem_refresh_active | ( | bContext * | C | ) |
Use to update the active tool (shown in the top bar) in the least disruptive way.
This is a little involved since there may be multiple valid active tools depending on the mode and space type.
Used when undoing since the active mode may have changed.
Definition at line 801 of file wm_toolsystem.cc.
References bScreen::areabase, BKE_workspace_id_tag_all_visible(), C, CTX_data_main(), CTX_wm_area(), CTX_wm_area_set(), CTX_wm_region(), CTX_wm_region_set(), CTX_wm_window(), CTX_wm_window_set(), ListBase::first, ID_TAG_DOIT, LISTBASE_FOREACH, bToolKey::mode, bToolRef::runtime, bToolKey::space_type, toolsystem_refresh_ref(), toolsystem_reinit_ensure_toolref(), Main::wm, WM_toolsystem_mode_from_spacetype(), WM_toolsystem_ref_find(), WM_TOOLSYSTEM_SPACE_MASK, WM_window_get_active_scene(), WM_window_get_active_screen(), WM_window_get_active_view_layer(), WM_window_get_active_workspace(), and Main::workspaces.
Referenced by ed_undo_step_post().
Definition at line 578 of file wm_toolsystem.cc.
References BLI_assert, C, LISTBASE_FOREACH, WorkSpace::tools, and toolsystem_refresh_ref().
| void WM_toolsystem_refresh_screen_all | ( | Main * | bmain | ) |
Definition at line 913 of file wm_toolsystem.cc.
References ListBase::first, LISTBASE_FOREACH, Main::wm, and WM_toolsystem_refresh_screen_window().
Referenced by ed_undo_step_post().
| bool WM_toolsystem_refresh_screen_area | ( | WorkSpace * | workspace, |
| const Scene * | scene, | ||
| ViewLayer * | view_layer, | ||
| ScrArea * | area ) |
Definition at line 872 of file wm_toolsystem.cc.
References ScrArea_Runtime::is_tool_set, LISTBASE_FOREACH, ScrArea::runtime, ScrArea::spacetype, ScrArea_Runtime::tool, WorkSpace::tools, and WM_toolsystem_mode_from_spacetype().
Referenced by ED_area_init(), WM_toolsystem_do_msg_notify_tag_refresh(), and WM_toolsystem_refresh_screen_window().
| void WM_toolsystem_refresh_screen_window | ( | wmWindow * | win | ) |
Definition at line 894 of file wm_toolsystem.cc.
References bScreen::areabase, LISTBASE_FOREACH, SPACE_TYPE_NUM, WorkSpace::tools, 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 ED_screen_scene_change(), and WM_toolsystem_refresh_screen_all().
Definition at line 554 of file wm_toolsystem.cc.
References C, toolsystem_reinit_ref(), and WM_toolsystem_ref_find().
Definition at line 585 of file wm_toolsystem.cc.
References bScreen::areabase, C, LISTBASE_FOREACH, bToolKey::mode, bToolKey::space_type, bToolRef::tag, toolsystem_reinit_ref(), WM_toolsystem_mode_from_spacetype(), WM_toolsystem_ref_find(), WM_TOOLSYSTEM_SPACE_MASK, WM_window_get_active_scene(), WM_window_get_active_screen(), WM_window_get_active_view_layer(), and WM_window_get_active_workspace().
| bToolRef_Runtime * WM_toolsystem_runtime_find | ( | WorkSpace * | workspace, |
| const bToolKey * | tkey ) |
Definition at line 116 of file wm_toolsystem.cc.
References bToolRef::runtime, and WM_toolsystem_ref_find().
| bToolRef_Runtime * WM_toolsystem_runtime_from_context | ( | const bContext * | C | ) |
Definition at line 99 of file wm_toolsystem.cc.
References C, bToolRef::runtime, and WM_toolsystem_ref_from_context().
Referenced by ED_gizmo_poll_or_unlink_delayed_from_tool_ex(), view3d_ruler_poll(), WM_toolsystem_active_tool_has_custom_cursor(), and WM_toolsystem_active_tool_is_brush().
Definition at line 200 of file wm_toolsystem.cc.
References C, bToolRef::runtime, toolsystem_unlink_ref(), and WM_toolsystem_ref_find().
Operate on all active tools.
Definition at line 562 of file wm_toolsystem.cc.
References C, LISTBASE_FOREACH, WorkSpace::tools, and toolsystem_unlink_ref().
| void WM_toolsystem_update_from_context | ( | bContext * | C, |
| WorkSpace * | workspace, | ||
| const Scene * | scene, | ||
| ViewLayer * | view_layer, | ||
| ScrArea * | area ) |
Definition at line 1220 of file wm_toolsystem.cc.
References C, bToolKey::mode, bToolKey::space_type, ScrArea::spacetype, toolsystem_key_ensure_check(), toolsystem_reinit_ensure_toolref(), and WM_toolsystem_mode_from_spacetype().
Referenced by wm_draw_area_offscreen().
| void WM_toolsystem_update_from_context_view3d | ( | bContext * | C | ) |
Definition at line 1187 of file wm_toolsystem.cc.
References BLI_listbase_is_single(), C, CTX_data_main(), CTX_wm_area(), CTX_wm_area_set(), CTX_wm_region(), CTX_wm_region_set(), CTX_wm_window(), CTX_wm_window_set(), CTX_wm_workspace(), ListBase::first, LISTBASE_FOREACH, wmWindowManager::windows, Main::wm, wm_toolsystem_update_from_context_view3d_impl(), and WM_window_get_active_workspace().
Referenced by blender::ed::sculpt_paint::curves_sculptmode_toggle_exec(), ed_object_select_pick(), blender::ed::object::editmode_toggle_exec(), blender::ed::object::object_transfer_mode_invoke(), blender::ed::greasepencil::paintmode_toggle_exec(), particle_edit_toggle_exec(), blender::ed::object::posemode_exec(), blender::ed::sculpt_paint::sculpt_mode_toggle_exec(), blender::ed::greasepencil::sculptmode_toggle_exec(), texture_paint_toggle_exec(), blender::ed::greasepencil::vertexmode_toggle_exec(), vpaint_mode_toggle_exec(), blender::ed::greasepencil::weightmode_toggle_exec(), and wpaint_mode_toggle_exec().