Blender V5.3
blender::wmGizmo Struct Reference

#include <WM_gizmo_types.hh>

Classes

union  [union].temp

Public Attributes

wmGizmo * next
wmGizmo * prev
const wmGizmoType * type
wmGizmoFnModal custom_modal
wmGizmoGroup * parent_gzgroup
wmKeyMap * keymap
void * py_instance
PointerRNA * ptr
eWM_GizmoFlag flag
eWM_GizmoFlagState state
int highlight_part
int drag_part
float select_bias
float matrix_space [4][4]
float matrix_basis [4][4]
float matrix_offset [4][4]
float scale_final
float scale_basis
float line_width
float color [4]
float color_hi [4]
void * interaction_data
Vector< wmGizmoOpElem, 4 > op_data
IDProperty * properties
Vector< wmGizmoProperty, 0 > target_properties
bool do_draw
union  temp

Detailed Description

Gizmos are set per region by registering them on gizmo-maps.

Definition at line 234 of file WM_gizmo_types.hh.

Member Data Documentation

◆ color

◆ color_hi

◆ custom_modal

wmGizmoFnModal blender::wmGizmo::custom_modal

◆ do_draw

bool blender::wmGizmo::do_draw

Redraw tag.

Definition at line 319 of file WM_gizmo_types.hh.

Referenced by blender::wm_region_test_gizmo_do_draw().

◆ drag_part

int blender::wmGizmo::drag_part

For gizmos that differentiate between click & drag, use a different part for any drag events, -1 when unused.

Definition at line 272 of file WM_gizmo_types.hh.

Referenced by blender::gizmo_tweak_invoke(), blender::ui::tooltip_data_from_gizmo(), blender::WIDGETGROUP_navigate_setup(), and blender::wm_gizmo_create().

◆ flag

eWM_GizmoFlag blender::wmGizmo::flag

Flags that influence the behavior or how the gizmos are drawn.

Definition at line 258 of file WM_gizmo_types.hh.

Referenced by blender::dial_draw_intern(), blender::ED_gizmo_button2d_group_background(), blender::ed::transform::gizmo2d_resize_refresh(), blender::ed::transform::gizmo2d_rotate_refresh(), blender::ed::transform::gizmo2d_xform_refresh(), blender::ed::transform::gizmo2d_xform_setup(), blender::gizmo_arrow_setup(), blender::gizmo_cage2d_setup(), blender::gizmo_cage3d_setup(), blender::gizmo_color_get(), blender::gizmo_draw_select_3d_loop(), blender::gizmo_find_intersected_3d_intern(), blender::ed::transform::gizmo_mesh_extrude_draw_prepare(), blender::ed::transform::gizmo_mesh_extrude_setup(), blender::gizmo_mesh_spin_init_setup(), blender::gizmo_move_modal(), blender::gizmo_move_test_select(), blender::gizmo_preselect_edgering_setup(), blender::gizmo_preselect_elem_setup(), blender::gizmo_primitive_setup(), blender::gizmo_tweak_finish(), blender::move_geom_draw(), blender::snap_cursor_poll(), blender::snap_gizmo_setup(), blender::tool_generic_create_gizmo(), blender::WIDGETGROUP_camera_setup(), blender::ui::WIDGETGROUP_navigate_setup(), blender::WIDGETGROUP_navigate_setup(), blender::WM_gizmo_calc_matrix_final_params(), blender::wm_gizmo_is_visible(), blender::WM_gizmo_operator_invoke(), blender::WM_gizmo_set_flag(), blender::wm_gizmogroup_find_intersected_gizmo(), blender::WM_gizmomap_gizmo_hash_new(), blender::WM_gizmomap_message_subscribe(), blender::wm_gizmomap_modal_set(), blender::wm_handler_operator_call(), and blender::wm_handlers_do_gizmo_handler().

◆ highlight_part

◆ interaction_data

◆ keymap

wmKeyMap* blender::wmGizmo::keymap

Optional keymap to use for this gizmo (overrides #wmGizmoGroupType.keymap).

Definition at line 250 of file WM_gizmo_types.hh.

Referenced by blender::tool_generic_create_gizmo(), blender::WIDGETGROUP_navigate_setup(), blender::wm_gizmo_keymap_uses_event_modifier(), and blender::wm_handlers_do_gizmo_handler().

◆ line_width

◆ matrix_basis

float blender::wmGizmo::matrix_basis[4][4]

Transformation of this gizmo.

Definition at line 291 of file WM_gizmo_types.hh.

Referenced by blender::button2d_draw_intern(), blender::dial_draw_intern(), blender::dial_ghostarc_get_angles(), blender::ed::transform::gizmo2d_xform_draw_prepare(), blender::ed::transform::gizmo_3d_draw_invoke(), blender::gizmo_arrow_matrix_basis_get(), blender::gizmo_arrow_modal(), blender::gizmo_axis_screen_bounds_get(), blender::gizmo_axis_test_select(), blender::gizmo_bisect_prop_depth_get(), blender::gizmo_bisect_prop_depth_set(), blender::gizmo_button2d_test_select(), blender::gizmo_dial_modal(), blender::gizmo_dial_setup(), blender::ed::transform::gizmo_mesh_extrude_draw_prepare(), blender::ed::transform::gizmo_mesh_extrude_orientation_matrix_set_for_adjust(), blender::ed::transform::gizmo_mesh_extrude_refresh(), blender::gizmo_mesh_placement_modal_from_setup(), blender::gizmo_move_matrix_basis_get(), blender::gizmo_placement_prop_matrix_get(), blender::gizmo_placement_prop_matrix_set(), blender::ed::transform::gizmo_refresh_from_matrix(), blender::gizmo_spin_prop_axis_angle_get(), blender::gizmo_spin_prop_axis_angle_set(), blender::gizmo_spin_prop_depth_get(), blender::gizmo_spin_prop_depth_set(), blender::ed::view3d::geometry_nodes_gizmos::TransformGizmos::update_rotate_transform_and_target_property(), blender::ed::view3d::geometry_nodes_gizmos::TransformGizmos::update_scale_transform_and_target_property(), blender::ed::view3d::geometry_nodes_gizmos::TransformGizmos::update_translate_transform_and_target_property(), blender::WIDGETGROUP_armature_spline_setup(), blender::WIDGETGROUP_camera_refresh(), blender::WIDGETGROUP_empty_image_refresh(), blender::WIDGETGROUP_light_area_refresh(), blender::WIDGETGROUP_light_spot_refresh(), blender::WIDGETGROUP_light_target_draw_prepare(), blender::ui::WIDGETGROUP_navigate_draw_prepare(), blender::WIDGETGROUP_navigate_draw_prepare(), blender::WIDGETGROUP_tool_generic_refresh(), blender::ed::transform::WIDGETGROUP_xform_shear_draw_prepare(), blender::ed::transform::WIDGETGROUP_xform_shear_refresh(), blender::WM_gizmo_calc_matrix_final_params(), blender::wm_gizmo_calculate_scale(), blender::wm_gizmo_create(), blender::WM_gizmo_set_matrix_location(), blender::WM_gizmo_set_matrix_rotation_from_yz_axis(), and blender::WM_gizmo_set_matrix_rotation_from_z_axis().

◆ matrix_offset

float blender::wmGizmo::matrix_offset[4][4]

Custom offset from origin.

Definition at line 293 of file WM_gizmo_types.hh.

Referenced by blender::ed::transform::gizmo2d_xform_draw_prepare(), blender::ed::transform::gizmo_3d_draw_invoke(), blender::ed::transform::gizmo_3d_setup_default_matrix(), blender::ed::transform::gizmo_3d_setup_draw_from_twtype(), blender::gizmo_axis_draw(), blender::gizmo_axis_test_select(), blender::gizmo_cage2d_exit(), blender::gizmo_cage2d_invoke(), blender::gizmo_cage2d_modal(), blender::gizmo_cage2d_property_update(), blender::gizmo_cage3d_exit(), blender::gizmo_cage3d_invoke(), blender::gizmo_cage3d_modal(), blender::gizmo_cage3d_property_update(), blender::gizmo_calc_rect_view_scale(), blender::gizmo_calc_rect_view_scale(), blender::ed::transform::gizmo_mesh_extrude_draw_prepare(), blender::ed::transform::gizmo_mesh_extrude_orientation_matrix_set(), blender::ed::transform::gizmo_mesh_extrude_refresh(), blender::gizmo_mesh_placement_modal_from_setup(), blender::gizmo_mesh_placement_update_from_op(), blender::gizmo_mesh_spin_init_refresh(), blender::gizmo_placement_prop_matrix_get(), blender::tool_generic_create_gizmo(), blender::ed::view3d::geometry_nodes_gizmos::TransformGizmos::update_translate_style(), blender::WIDGETGROUP_light_target_draw_prepare(), blender::ed::transform::WIDGETGROUP_xform_cage_refresh(), blender::ed::transform::WIDGETGROUP_xform_shear_draw_prepare(), blender::WM_gizmo_calc_matrix_final_params(), blender::wm_gizmo_create(), blender::WM_gizmo_set_matrix_offset_location(), blender::WM_gizmo_set_matrix_offset_rotation_from_yz_axis(), and blender::WM_gizmo_set_matrix_offset_rotation_from_z_axis().

◆ matrix_space

◆ next

wmGizmo* blender::wmGizmo::next

Definition at line 235 of file WM_gizmo_types.hh.

Referenced by blender::view3d_ruler_to_gpencil().

◆ op_data

Vector<wmGizmoOpElem, 4> blender::wmGizmo::op_data

Operator to spawn when activating the gizmo (overrides property editing), an array of items (aligned with #wmGizmo.highlight_part).

Definition at line 310 of file WM_gizmo_types.hh.

Referenced by blender::ed::transform::gizmo_modal(), blender::WM_gizmo_free(), blender::WM_gizmo_operator_get(), blender::WM_gizmo_operator_set(), blender::WM_gizmo_target_property_clear_rna_ptr(), blender::WM_gizmo_target_property_def_func_ptr(), and blender::WM_gizmo_target_property_def_rna_ptr().

◆ parent_gzgroup

wmGizmoGroup* blender::wmGizmo::parent_gzgroup

Pointer back to group this gizmo is in (just for quick access).

Definition at line 247 of file WM_gizmo_types.hh.

Referenced by blender::button2d_draw_intern(), blender::gizmo_bisect_prop_angle_get(), blender::gizmo_bisect_prop_angle_set(), blender::gizmo_bisect_prop_depth_get(), blender::gizmo_bisect_prop_depth_set(), blender::gizmo_bisect_prop_translate_get(), blender::gizmo_bisect_prop_translate_set(), blender::gizmo_button2d_bounds(), blender::gizmo_cage2d_get_cursor(), blender::gizmo_cage3d_get_cursor(), blender::gizmo_draw_select_3d_loop(), blender::ed::transform::gizmo_modal(), blender::nodes::gizmos::gizmo_node_backdrop_prop_matrix_get(), blender::nodes::gizmos::gizmo_node_backdrop_prop_matrix_set(), blender::nodes::gizmos::gizmo_node_box_mask_prop_matrix_get(), blender::nodes::gizmos::gizmo_node_box_mask_prop_matrix_set(), blender::nodes::gizmos::gizmo_node_crop_prop_matrix_get(), blender::nodes::gizmos::gizmo_node_crop_prop_matrix_set(), blender::nodes::gizmos::gizmo_node_scale_prop_matrix_get(), blender::nodes::gizmos::gizmo_node_scale_prop_matrix_set(), blender::nodes::gizmos::gizmo_node_split_prop_matrix_get(), blender::nodes::gizmos::gizmo_node_split_prop_matrix_set(), blender::nodes::gizmos::gizmo_node_transform_prop_matrix_get(), blender::nodes::gizmos::gizmo_node_transform_prop_matrix_set(), blender::nodes::gizmos::gizmo_node_translate_prop_offset_get(), blender::nodes::gizmos::gizmo_node_translate_prop_offset_set(), blender::gizmo_placement_prop_matrix_get(), blender::gizmo_placement_prop_matrix_set(), blender::gizmo_ruler_draw(), blender::gizmo_ruler_exit(), blender::gizmo_ruler_invoke(), blender::gizmo_ruler_modal(), blender::gizmo_ruler_test_select(), blender::gizmo_selectable_poll(), blender::gizmo_spin_prop_angle_get(), blender::gizmo_spin_prop_angle_set(), blender::gizmo_spin_prop_axis_angle_get(), blender::gizmo_spin_prop_axis_angle_set(), blender::gizmo_spin_prop_depth_get(), blender::gizmo_spin_prop_depth_set(), blender::gizmo_spin_prop_translate_get(), blender::gizmo_spin_prop_translate_set(), blender::gizmo_tweak_finish(), blender::gizmo_tweak_invoke(), blender::gizmo_tweak_start_and_finish(), blender::gizmo_window_project_2d(), blender::gizmo_window_project_3d(), blender::ed::transform::gizmogroup_xform_find(), blender::gizmomap_prepare_drawing(), blender::gizmos_draw_list(), blender::snap_cursor_poll(), blender::ed::transform::transform_gizmo_3d_model_from_constraint_and_mode_init(), blender::wm_gizmo_calculate_scale(), blender::WM_gizmo_group_is_modal(), blender::WM_gizmo_group_refresh(), blender::WM_gizmo_target_property_subscribe_all(), blender::wm_gizmogroup_gizmo_register(), blender::wm_gizmomap_modal_set(), blender::WM_gizmomap_tooltip_init(), and blender::wm_handlers_do_gizmo_handler().

◆ prev

wmGizmo * blender::wmGizmo::prev

Definition at line 235 of file WM_gizmo_types.hh.

◆ properties

IDProperty* blender::wmGizmo::properties

◆ ptr

PointerRNA* blender::wmGizmo::ptr

Rna pointer to access properties.

Definition at line 255 of file WM_gizmo_types.hh.

Referenced by blender::arrow_draw_geom(), blender::arrow_draw_intern(), blender::nodes::gizmos::box_mask_refresh(), blender::nodes::gizmos::box_mask_setup(), blender::button2d_draw_intern(), blender::nodes::gizmos::corner_pin_setup(), blender::nodes::gizmos::crop_refresh(), blender::nodes::gizmos::crop_setup(), blender::dial_draw_intern(), blender::dial_ghostarc_get_angles(), blender::ED_view3d_gizmo_mesh_preselect_clear(), blender::ED_view3d_gizmo_mesh_preselect_get_active(), blender::nodes::gizmos::ellipse_mask_setup(), blender::ed::transform::gizmo2d_resize_setup(), blender::ed::transform::gizmo2d_rotate_setup(), blender::ed::transform::gizmo2d_xform_setup(), blender::ed::transform::gizmo_3d_draw_invoke(), blender::ed::transform::gizmo_3d_setup_draw_default(), blender::ed::transform::gizmo_3d_setup_draw_from_twtype(), blender::ed::transform::gizmo_3d_setup_draw_modal(), blender::gizmo_arrow_exit(), blender::gizmo_arrow_invoke(), blender::gizmo_arrow_modal(), blender::gizmo_arrow_property_update(), blender::gizmo_arrow_test_select(), blender::gizmo_button2d_cursor_get(), blender::gizmo_cage2d_draw_intern(), blender::gizmo_cage2d_modal(), blender::gizmo_cage2d_test_select(), blender::gizmo_cage2d_transform_flag_get(), blender::gizmo_cage3d_draw_intern(), blender::gizmo_cage3d_modal(), blender::gizmo_dial_draw(), blender::gizmo_dial_draw_select(), blender::gizmo_dial_exit(), blender::gizmo_dial_modal(), blender::gizmo_empty_image_prop_matrix_get(), blender::gizmo_empty_image_prop_matrix_set(), blender::gizmo_mesh_bisect_setup(), blender::ed::transform::gizmo_mesh_extrude_refresh(), blender::ed::transform::gizmo_mesh_extrude_setup(), blender::gizmo_mesh_placement_setup(), blender::gizmo_mesh_spin_init_draw_prepare(), blender::gizmo_mesh_spin_init_setup(), blender::gizmo_mesh_spin_redo_setup(), blender::ed::transform::gizmo_modal(), blender::gizmo_move_invoke(), blender::gizmo_preselect_edgering_test_select(), blender::gizmo_preselect_elem_test_select(), blender::ed::transform::gizmo_refresh_from_matrix(), blender::gizmo_spin_exec(), blender::ed::transform::gizmogroup2d_init(), blender::nodes::gizmos::glare_setup(), blender::move3d_draw_intern(), blender::move_geom_draw(), blender::ringcut_invoke(), blender::nodes::gizmos::scale_refresh(), blender::nodes::gizmos::scale_setup(), blender::nodes::gizmos::split_refresh(), blender::nodes::gizmos::split_setup(), blender::tool_generic_create_gizmo(), blender::nodes::gizmos::transform_refresh(), blender::nodes::gizmos::transform_setup(), blender::nodes::gizmos::translate_setup(), blender::ed::view3d::geometry_nodes_gizmos::TransformGizmos::update_rotate_style(), blender::ed::view3d::geometry_nodes_gizmos::TransformGizmos::update_scale_style(), blender::ed::view3d::geometry_nodes_gizmos::TransformGizmos::update_translate_style(), blender::view3d_ruler_item_mousemove(), blender::nodes::gizmos::viewer_refresh(), blender::nodes::gizmos::viewer_setup(), blender::WIDGETGROUP_armature_spline_setup(), blender::WIDGETGROUP_camera_refresh(), blender::WIDGETGROUP_camera_setup(), blender::WIDGETGROUP_camera_view_refresh(), blender::WIDGETGROUP_camera_view_setup(), blender::WIDGETGROUP_empty_image_refresh(), blender::WIDGETGROUP_empty_image_setup(), blender::WIDGETGROUP_forcefield_setup(), blender::WIDGETGROUP_light_area_refresh(), blender::WIDGETGROUP_light_area_setup(), blender::WIDGETGROUP_light_point_setup(), blender::WIDGETGROUP_light_spot_setup(), blender::WIDGETGROUP_light_target_setup(), blender::ui::WIDGETGROUP_navigate_setup(), blender::WIDGETGROUP_navigate_setup(), blender::WIDGETGROUP_ruler_setup(), blender::ed::transform::WIDGETGROUP_xform_cage_refresh(), blender::ed::transform::WIDGETGROUP_xform_cage_setup(), blender::ed::transform::WIDGETGROUP_xform_shear_setup(), blender::wm_gizmo_create(), blender::WM_gizmo_free(), and blender::WM_gizmo_properties_reset().

◆ py_instance

void* blender::wmGizmo::py_instance

Definition at line 252 of file WM_gizmo_types.hh.

Referenced by blender::WM_gizmo_free().

◆ scale_basis

◆ scale_final

◆ select_bias

float blender::wmGizmo::select_bias

◆ state

◆ target_properties

◆ temp

◆ type

const wmGizmoType* blender::wmGizmo::type

While we don't have a real type, use this to put type-like vars.

Definition at line 238 of file WM_gizmo_types.hh.

Referenced by blender::ED_gizmo_button2d_group_background(), blender::ED_view3d_gizmo_mesh_preselect_clear(), blender::gizmo_draw_select_3d_loop(), blender::gizmo_find_intersected_3d(), blender::gizmo_tweak_finish(), blender::gizmo_tweak_modal(), blender::gizmo_update_prop_data(), blender::gizmo_window_project_2d(), blender::gizmo_window_project_3d(), blender::gizmos_draw_list(), blender::py_rna_gizmo_target_id_parse(), blender::py_rna_gizmo_target_id_parse_and_ensure_is_valid(), blender::py_rna_gizmo_target_type_id_parse(), blender::ui::tooltip_create_from_gizmo(), blender::ed::transform::transform_mode_snap_source_init(), blender::WIDGETGROUP_camera_refresh(), blender::WM_gizmo_calc_matrix_final_params(), blender::wm_gizmo_calculate_scale(), blender::wm_gizmo_create(), blender::WM_gizmo_free(), blender::WM_gizmo_new_ptr(), blender::WM_gizmo_properties_reset(), blender::wm_gizmo_select_set_ex(), blender::WM_gizmo_target_property_clear_rna(), blender::WM_gizmo_target_property_def_func(), blender::WM_gizmo_target_property_def_func_ptr(), blender::WM_gizmo_target_property_def_rna(), blender::WM_gizmo_target_property_def_rna_ptr(), blender::WM_gizmo_target_property_find(), blender::wm_gizmogroup_find_intersected_gizmo(), blender::WM_gizmomap_cursor_set(), blender::wm_gizmomap_highlight_set(), blender::wm_gizmomap_modal_set(), and blender::wm_gizmomaps_handled_modal_update().


The documentation for this struct was generated from the following file: