 |
Blender V5.0
|
|
Blender V5.0
|
#include <WM_types.hh>
Definition at line 1031 of file WM_types.hh.
| void(* wmOperatorType::cancel) (bContext *C, wmOperator *op) |
Called when a modal operator is canceled (not used often). Internal cleanup can be done here if needed.
Definition at line 1073 of file WM_types.hh.
Referenced by blender::ed::sculpt_paint::paint_stroke_modal(), WM_event_remove_handlers(), wm_handler_fileselect_do(), wm_macro_cancel(), and wm_operator_ui_popup_cancel().
| bool(* wmOperatorType::check) (bContext *C, wmOperator *op) |
This callback executes on a running operator whenever as property is changed. It can correct its own properties or report errors for invalid settings in exceptional cases. Boolean return value, True denotes a change has been made and to redraw.
Definition at line 1057 of file WM_types.hh.
Referenced by ED_undo_operator_repeat(), file_draw_check_ex(), popup_check(), and WM_event_add_fileselect().
| int wmOperatorType::cursor_pending |
Cursor to use when waiting for cursor input, see: OPTYPE_DEPENDS_ON_CURSOR.
Definition at line 1154 of file WM_types.hh.
| bool(* wmOperatorType::depends_on_cursor) (bContext &C, wmOperatorType &ot, PointerRNA *ptr) |
A dynamic version of OPTYPE_DEPENDS_ON_CURSOR which can depend on operator properties.
Definition at line 1124 of file WM_types.hh.
| const char* wmOperatorType::description |
Use for tooltips and Python docs.
Definition at line 1039 of file WM_types.hh.
Referenced by file_execute_get_description(), and blender::ed::space_node::NODE_OT_new_compositor_sequencer_node_group().
| wmOperatorStatus(* wmOperatorType::exec) (bContext *C, wmOperator *op) ATTR_WARN_UNUSED_RESULT |
This callback executes the operator without any interactive input, parameters may be provided through operator properties. cannot use any interface code or input device state. See defines below for return values.
Definition at line 1049 of file WM_types.hh.
Referenced by gesture_box_apply(), gesture_circle_apply(), gesture_lasso_apply(), gesture_polyline_apply(), gesture_straightline_apply(), insert_key_menu_invoke(), blender::ed::space_node::NODE_OT_new_compositor_sequencer_node_group(), blender::ed::object::object_add_drop_xy_generic_invoke(), blender::ed::object::object_instance_add_invoke(), op_generic_value_modal(), primitive_add_invoke(), WM_generic_select_modal(), wm_handler_fileselect_do(), wm_macro_invoke_internal(), WM_menu_invoke_ex(), WM_operator_confirm_or_exec(), wm_operator_exec(), wm_operator_exec_notest(), wm_operator_invoke(), and WM_operator_repeat_check().
| short wmOperatorType::flag |
Flag last for padding.
Definition at line 1157 of file WM_types.hh.
Referenced by blender::ed::space_node::NODE_OT_new_compositor_sequencer_node_group(), repeat_history_invoke(), repeat_last_exec(), blender::ed::vse::sequencer_slip_invoke(), template_operator_property_buts_draw_recursive(), template_operator_property_buts_draw_single(), ui_layout_operator_properties_only_booleans(), wm_block_create_redo(), WM_event_remove_handlers(), wm_handler_fileselect_do(), wm_handler_operator_insert(), wm_macro_modal(), wm_operator_exec(), wm_operator_finished(), wm_operator_invoke(), wm_operator_props_popup_ex(), WM_operator_redo_popup(), wm_operator_register(), and wm_operator_reports().
| std::string(* wmOperatorType::get_description) (bContext *C, wmOperatorType *ot, PointerRNA *ptr) |
Return a different description to use in the user interface, based on property values. The returned string is expected to be translated if needed.
Definition at line 1121 of file WM_types.hh.
Referenced by ui_but_tip_from_enum_item().
| std::string(* wmOperatorType::get_name) (wmOperatorType *ot, PointerRNA *ptr) |
Return a different name to use in the user interface, based on property values. The returned string is expected to be translated if needed.
WARNING: This callback does not currently work as expected in most common usage cases (e.g. any definition of an operator button through the layout API will fail to execute it). See #112253 for details.
Definition at line 1115 of file WM_types.hh.
| const char* wmOperatorType::idname |
Unique identifier (must not exceed OP_MAX_TYPENAME).
Definition at line 1035 of file WM_types.hh.
Referenced by depthdropper_poll(), ED_gizmo_poll_or_unlink_delayed_from_operator(), ED_undo_operator_repeat(), fluid_free_exec(), fluid_initjob(), get_operators_map(), gizmo_mesh_bisect_setup(), gizmo_mesh_placement_setup(), blender::ed::object::move_to_collection_invoke(), move_to_collection_regular_invoke(), blender::ed::space_node::NODE_OT_new_compositor_sequencer_node_group(), operator_last_properties_init_impl(), ptcache_bake_exec(), ptcache_bake_invoke(), shortcut_get_operator_property(), template_operator_property_buts_draw_single(), toggle_cyclic_invoke(), blender::ed::transform::transformops_loopsel_hack(), blender::ed::transform::transformops_mode(), ui_but_event_operator_string_from_operator(), UI_but_online_manual_id(), UI_but_string_get_rna_struct_identifier(), ui_tooltip_data_from_gizmo(), ui_tooltip_data_from_tool(), unpack_item_invoke(), blender::ed::object::bake_simulation::unpack_single_bake_invoke(), uv_mark_seam_invoke(), uv_sculpt_stroke_init(), wm_handler_op_context_get_if_valid(), wm_homefile_read_exec(), WM_menu_invoke_ex(), WM_operator_last_properties_store(), wm_operator_props_popup_ex(), WM_operator_pystring_ex(), WM_operator_redo_popup(), wm_search_menu_invoke(), wm_userpref_read_exec(), and workspace_append_button().
| wmOperatorStatus(* wmOperatorType::invoke) (bContext *C, wmOperator *op, const wmEvent *event) ATTR_WARN_UNUSED_RESULT |
For modal temporary operators, initially invoke is called, then any further events are handled in modal. If the operation is canceled due to some external reason, cancel is called See defines below for return values.
Definition at line 1065 of file WM_types.hh.
Referenced by wm_macro_invoke_internal(), wm_operator_invoke(), and wm_save_as_mainfile_exec().
| IDProperty* wmOperatorType::last_properties |
Previous settings - for initializing on re-use.
Definition at line 1130 of file WM_types.hh.
Referenced by WM_operator_last_properties_init(), and WM_operator_last_properties_store().
| ListBase wmOperatorType::macro |
Definition at line 1142 of file WM_types.hh.
Referenced by WM_operator_repeat_check().
| wmOperatorStatus(* wmOperatorType::modal) (bContext *C, wmOperator *op, const wmEvent *event) ATTR_WARN_UNUSED_RESULT |
Modal is used for operators which continuously run. Fly mode, knife tool, circle select are all examples of modal operators. Modal operators can handle events which would normally invoke or execute other operators. They keep running until they don't return OPERATOR_RUNNING_MODAL.
Definition at line 1081 of file WM_types.hh.
Referenced by gizmo_tweak_start_and_finish(), blender::ed::sculpt_paint::grease_pencil_brush_stroke_invoke(), blender::ed::sculpt_paint::grease_pencil_sculpt_paint_invoke(), blender::ed::sculpt_paint::grease_pencil_vertex_brush_stroke_invoke(), blender::ed::sculpt_paint::grease_pencil_weight_brush_stroke_invoke(), blender::ed::sculpt_paint::image::ops::paint::paint_invoke(), blender::ed::sculpt_paint::sculpt_brush_stroke_invoke(), blender::ed::sculpt_paint::sculpt_curves_stroke_invoke(), vpaint_invoke(), WM_generic_select_invoke(), wm_macro_modal(), wm_xr_navigation_teleport_invoke(), wm_xr_session_events_dispatch(), and wpaint_invoke().
| wmKeyMap* wmOperatorType::modalkeymap |
Pointer to modal keymap. Do not free!
Definition at line 1145 of file WM_types.hh.
Referenced by blender::ed::transform::initTransform(), blender::ed::transform::initTransInfo(), WM_event_add_modal_handler_ex(), wm_event_modalkeymap_begin(), wm_handler_operator_call(), and WM_window_modal_keymap_status_draw().
| const char* wmOperatorType::name |
Text for UI, undo (should not exceed OP_MAX_TYPENAME).
Definition at line 1033 of file WM_types.hh.
Referenced by button_matches_search_filter(), clear_render_border_exec(), ED_imapaint_bucket_fill(), ED_undo_grouped_push_op(), ED_undo_operator_repeat(), ED_undo_pop_op(), ED_undo_push_op(), ed_undo_redo_poll(), fluid_free_exec(), fluid_initjob(), fly_modal(), blender::ed::sculpt_paint::undo::geometry_begin(), hud_panel_operator_redo_draw(), image_flip_exec(), image_invert_exec(), image_rotate_orthogonal_exec(), image_scale_exec(), keyingset_active_menu_invoke(), move_to_collection_regular_invoke(), blender::ed::object::multires_base_apply_exec(), blender::ed::space_node::NODE_OT_new_compositor_sequencer_node_group(), blender::ed::object::object_hide_collection_invoke(), pack_islands_exec(), paintcurve_delete_point_exec(), paintcurve_point_add(), paintcurve_point_select(), paintcurve_slide_modal(), blender::ed::sculpt_paint::undo::push_begin(), blender::ed::sculpt_paint::undo::push_enter_sculpt_mode(), radial_control_modal(), render_border_exec(), stroke_undo_begin(), text_autocomplete_invoke(), text_autocomplete_modal(), texture_paint_camera_project_exec(), blender::ed::sculpt_paint::image::ops::paint::texture_paint_init(), blender::ed::transform::transformops_data(), view3d_all_exec(), view3d_navigate_modal_fn(), view3d_zoom_border_exec(), viewcenter_cursor_exec(), viewcenter_pick_invoke(), viewdolly_modal(), vieworbit_exec(), viewroll_exec(), viewselected_exec(), viewzoom_exec(), walk_modal(), wm_block_create_redo(), WM_operator_confirm(), WM_operator_confirm_or_exec(), and workspace_add_invoke().
| bool(* wmOperatorType::poll) (bContext *C) ATTR_WARN_UNUSED_RESULT |
Verify if the operator can be executed in the current context. Note that the operator may still fail to execute even if this returns true.
Definition at line 1089 of file WM_types.hh.
Referenced by blender::ed::sculpt_paint::min_distance_edit::min_distance_edit_invoke(), radial_control_invoke(), and WM_operator_redo_popup().
| bool(* wmOperatorType::poll_property) (const bContext *C, wmOperator *op, const PropertyRNA *prop) ATTR_WARN_UNUSED_RESULT |
Used to check if properties should be displayed in auto-generated UI. Use 'check' callback to enforce refreshing.
Definition at line 1095 of file WM_types.hh.
Referenced by template_operator_property_buts_draw_single(), and ui_layout_operator_properties_only_booleans().
| PropertyRNA* wmOperatorType::prop |
Default rna property to use for generic invoke functions. menus, enum search... etc. Example: Enum 'type' for a Delete menu.
When assigned a string/number property, immediately edit the value when used in a popup. see: UI_BUT_ACTIVATE_ON_INIT.
Definition at line 1139 of file WM_types.hh.
Referenced by delete_key_exec(), keyframe_insert_with_keyingset_exec(), blender::ed::object::make_override_library_exec(), blender::ed::object::make_override_library_invoke(), op_generic_value_invoke(), op_generic_value_modal(), blender::ed::object::parent_set_invoke(), template_operator_property_buts_draw_single(), and WM_menu_invoke_ex().
| bool(* wmOperatorType::pyop_poll) (bContext *C, wmOperatorType *ot) ATTR_WARN_UNUSED_RESULT |
Python needs the operator type as well.
Definition at line 1148 of file WM_types.hh.
| ExtensionRNA wmOperatorType::rna_ext |
RNA integration.
Definition at line 1151 of file WM_types.hh.
| StructRNA* wmOperatorType::srna |
RNA for properties.
Definition at line 1127 of file WM_types.hh.
Referenced by apply_armature_pose2bones_ui(), edbm_average_normals_ui(), edbm_normals_tools_ui(), edbm_point_normals_ui(), blender::ed::greasepencil::grease_pencil_convert_curve_type_ui(), blender::ed::greasepencil::grease_pencil_set_corner_type_ui(), blender::ed::greasepencil::grease_pencil_simplify_ui(), blender::ed::space_node::NODE_OT_new_compositor_sequencer_node_group(), operator_last_properties_init_impl(), template_operator_property_buts_draw_single(), UI_but_string_get_rna_label_context(), ui_layout_operator_properties_only_booleans(), unwrap_draw(), and WM_operator_properties_reset().
| const char* wmOperatorType::translation_context |
Translation context (must not exceed BKE_ST_MAXNAME).
Definition at line 1037 of file WM_types.hh.
Referenced by move_to_collection_regular_invoke(), and blender::ed::object::object_hide_collection_invoke().
| void(* wmOperatorType::ui) (bContext *C, wmOperator *op) |
Optional panel for redo and repeat, auto-generated if not set.
Definition at line 1100 of file WM_types.hh.
Referenced by template_operator_property_buts_draw_single().
| bool(* wmOperatorType::ui_poll) (wmOperatorType *ot, PointerRNA *ptr) |
Optional check for whether the ui callback should be called (usually to create the redo panel interface).
Definition at line 1105 of file WM_types.hh.
| const char* wmOperatorType::undo_group |
Identifier to group operators together.
Definition at line 1041 of file WM_types.hh.
Referenced by ED_undo_grouped_push_op().