Blender: wmGizmo Struct Reference

Blender V4.3

#include <WM_gizmo_types.hh>

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

blender::Vector< wmGizmoOpElem, 4 >	op_data

IDProperty *	properties

bool	do_draw

union {

float f

}	temp

Detailed Description

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

Definition at line 212 of file WM_gizmo_types.hh.

Member Data Documentation

◆ color

float wmGizmo::color[4]

Gizmo colors (uses default fallbacks if not defined).

Definition at line 273 of file WM_gizmo_types.hh.

Referenced by gizmo_cage2d_draw_intern(), gizmo_cage3d_draw_intern(), gizmo_color_get(), gizmo_init(), gizmo_mesh_bisect_setup(), gizmo_mesh_extrude_setup(), gizmo_mesh_placement_setup(), gizmo_mesh_spin_init_setup(), gizmo_mesh_spin_redo_setup(), tool_generic_create_gizmo(), blender::ed::view3d::geometry_nodes_gizmos::DialGizmo::update_style(), blender::ed::view3d::geometry_nodes_gizmos::LinearGizmo::update_style(), WIDGETGROUP_armature_spline_setup(), WIDGETGROUP_camera_setup(), WIDGETGROUP_empty_image_setup(), WIDGETGROUP_forcefield_setup(), WIDGETGROUP_light_area_setup(), WIDGETGROUP_light_point_setup(), WIDGETGROUP_light_spot_setup(), WIDGETGROUP_light_target_setup(), WIDGETGROUP_mesh_preselect_edgering_setup(), WIDGETGROUP_mesh_preselect_elem_setup(), WIDGETGROUP_navigate_setup(), WIDGETGROUP_navigate_setup(), WIDGETGROUP_xform_cage_setup(), WIDGETGROUP_xform_shear_setup(), WM_gizmo_get_color(), and WM_gizmo_set_color().

◆ color_hi

float wmGizmo::color_hi[4]

◆ custom_modal

wmGizmoFnModal wmGizmo::custom_modal

Overrides 'type->modal' when set. Note that this is a workaround, remove if we can.

Definition at line 220 of file WM_gizmo_types.hh.

Referenced by gizmo_dial_invoke(), gizmo_tweak_modal(), transform_mode_snap_source_init(), WM_gizmo_set_fn_custom_modal(), wm_gizmomap_modal_set(), and wm_gizmomaps_handled_modal_update().

◆ do_draw

bool wmGizmo::do_draw

Redraw tag.

Definition at line 285 of file WM_gizmo_types.hh.

◆ drag_part

int wmGizmo::drag_part

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

Definition at line 246 of file WM_gizmo_types.hh.

Referenced by gizmo_tweak_invoke(), ui_tooltip_data_from_gizmo(), WIDGETGROUP_navigate_setup(), and wm_gizmo_create().

◆ f

float wmGizmo::f

Definition at line 289 of file WM_gizmo_types.hh.

Referenced by WM_gizmo_cmp_temp_fl(), and WM_gizmo_cmp_temp_fl_reverse().

◆ flag

eWM_GizmoFlag wmGizmo::flag

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

Definition at line 234 of file WM_gizmo_types.hh.

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

◆ highlight_part

int wmGizmo::highlight_part

Optional ID for highlighting different parts of this gizmo. -1 when unset, otherwise a valid index. (Used as index to 'op_data').

Definition at line 240 of file WM_gizmo_types.hh.

Referenced by gizmo_axis_draw(), gizmo_cage2d_draw_intern(), gizmo_cage2d_get_cursor(), gizmo_cage2d_modal(), gizmo_cage3d_draw_intern(), gizmo_cage3d_modal(), gizmo_ruler_cursor_get(), gizmo_ruler_invoke(), gizmo_tweak_invoke(), gizmo_tweak_start_and_finish(), transform_gizmo_3d_model_from_constraint_and_mode_set(), ui_tooltip_data_from_gizmo(), view3d_ruler_add_invoke(), WM_gizmo_highlight_set(), WM_gizmo_modal_set_from_setup(), WM_gizmo_modal_set_while_modal(), wm_gizmo_select_and_highlight(), wm_gizmomap_highlight_set(), wm_gizmomap_modal_set(), wm_gizmomap_select_all_intern(), wm_gizmomaps_handled_modal_update(), and wm_handlers_do_gizmo_handler().

◆ interaction_data

void* wmGizmo::interaction_data

◆ keymap

wmKeyMap* wmGizmo::keymap

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

Definition at line 226 of file WM_gizmo_types.hh.

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

◆ line_width

float wmGizmo::line_width

User defined width for line drawing.

Definition at line 271 of file WM_gizmo_types.hh.

Referenced by arrow_draw_geom(), button2d_draw_intern(), button2d_geom_draw_backdrop(), dial_draw_intern(), gizmo_arrow_test_select(), gizmo_cage2d_draw_intern(), gizmo_cage3d_draw_intern(), gizmo_init(), gizmo_mesh_extrude_setup(), gizmo_primitive_draw_geom(), move_geom_draw(), and WM_gizmo_set_line_width().

◆ matrix_basis

float wmGizmo::matrix_basis[4][4]

Transformation of this gizmo.

Definition at line 263 of file WM_gizmo_types.hh.

Referenced by button2d_draw_intern(), dial_ghostarc_get_angles(), gizmo2d_xform_draw_prepare(), gizmo_3d_draw_invoke(), gizmo_arrow_matrix_basis_get(), gizmo_arrow_modal(), gizmo_axis_screen_bounds_get(), gizmo_axis_test_select(), gizmo_bisect_prop_depth_get(), gizmo_bisect_prop_depth_set(), gizmo_button2d_test_select(), gizmo_dial_draw(), gizmo_dial_draw_select(), gizmo_dial_modal(), gizmo_dial_setup(), gizmo_mesh_extrude_draw_prepare(), gizmo_mesh_extrude_orientation_matrix_set_for_adjust(), gizmo_mesh_extrude_refresh(), gizmo_mesh_placement_modal_from_setup(), gizmo_mesh_spin_redo_setup(), gizmo_placement_prop_matrix_get(), gizmo_placement_prop_matrix_set(), gizmo_spin_prop_axis_angle_get(), gizmo_spin_prop_axis_angle_set(), gizmo_spin_prop_depth_get(), gizmo_spin_prop_depth_set(), blender::ed::view3d::geometry_nodes_gizmos::DialGizmo::update_transform(), blender::ed::view3d::geometry_nodes_gizmos::LinearGizmo::update_transform(), WIDGETGROUP_armature_spline_setup(), WIDGETGROUP_camera_refresh(), WIDGETGROUP_empty_image_refresh(), WIDGETGROUP_light_area_refresh(), WIDGETGROUP_light_spot_refresh(), WIDGETGROUP_light_target_draw_prepare(), WIDGETGROUP_navigate_draw_prepare(), WIDGETGROUP_navigate_draw_prepare(), WIDGETGROUP_tool_generic_refresh(), WIDGETGROUP_xform_shear_draw_prepare(), WIDGETGROUP_xform_shear_refresh(), WM_gizmo_calc_matrix_final_params(), wm_gizmo_calculate_scale(), wm_gizmo_create(), WM_gizmo_set_matrix_location(), WM_gizmo_set_matrix_rotation_from_yz_axis(), WM_gizmo_set_matrix_rotation_from_z_axis(), and WM_gizmomap_minmax().

◆ matrix_offset

float wmGizmo::matrix_offset[4][4]

Custom offset from origin.

Definition at line 265 of file WM_gizmo_types.hh.

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

◆ matrix_space

float wmGizmo::matrix_space[4][4]

The space this gizmo is being modified in.

Definition at line 261 of file WM_gizmo_types.hh.

Referenced by gizmo2d_xform_draw_prepare(), gizmo_cage2d_modal(), gizmo_move_modal(), move3d_get_translate(), WIDGETGROUP_armature_spline_refresh(), WIDGETGROUP_camera_view_draw_prepare(), blender::ed::space_node::WIDGETGROUP_node_corner_pin_draw_prepare(), blender::ed::space_node::WIDGETGROUP_node_crop_draw_prepare(), blender::ed::space_node::WIDGETGROUP_node_sbeam_draw_prepare(), WIDGETGROUP_xform_cage_refresh(), WM_gizmo_calc_matrix_final_params(), wm_gizmo_calculate_scale(), and wm_gizmo_create().

◆ next

wmGizmo* wmGizmo::next

Definition at line 213 of file WM_gizmo_types.hh.

Referenced by gizmos_draw_list(), and view3d_ruler_to_gpencil().

◆ op_data

blender::Vector<wmGizmoOpElem, 4> 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 280 of file WM_gizmo_types.hh.

Referenced by gizmo_modal(), WM_gizmo_free(), WM_gizmo_operator_get(), WM_gizmo_operator_set(), WM_gizmo_target_property_clear_rna_ptr(), WM_gizmo_target_property_def_func_ptr(), and WM_gizmo_target_property_def_rna_ptr().

◆ parent_gzgroup

wmGizmoGroup* wmGizmo::parent_gzgroup

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

Definition at line 223 of file WM_gizmo_types.hh.

Referenced by button2d_draw_intern(), gizmo_bisect_prop_angle_get(), gizmo_bisect_prop_angle_set(), gizmo_bisect_prop_depth_get(), gizmo_bisect_prop_depth_set(), gizmo_bisect_prop_translate_get(), gizmo_bisect_prop_translate_set(), gizmo_button2d_bounds(), gizmo_cage2d_get_cursor(), gizmo_cage3d_get_cursor(), gizmo_draw_select_3d_loop(), gizmo_modal(), blender::ed::space_node::gizmo_node_crop_prop_matrix_get(), blender::ed::space_node::gizmo_node_crop_prop_matrix_set(), gizmo_placement_prop_matrix_get(), gizmo_placement_prop_matrix_set(), gizmo_ruler_draw(), gizmo_ruler_exit(), gizmo_ruler_invoke(), gizmo_ruler_modal(), gizmo_ruler_test_select(), gizmo_selectable_poll(), gizmo_spin_prop_angle_get(), gizmo_spin_prop_angle_set(), gizmo_spin_prop_axis_angle_get(), gizmo_spin_prop_axis_angle_set(), gizmo_spin_prop_depth_get(), gizmo_spin_prop_depth_set(), gizmo_spin_prop_translate_get(), gizmo_spin_prop_translate_set(), gizmo_tweak_finish(), gizmo_tweak_invoke(), gizmo_tweak_start_and_finish(), gizmo_window_project_2d(), gizmo_window_project_3d(), gizmogroup_xform_find(), gizmomap_prepare_drawing(), gizmos_draw_list(), snap_cursor_poll(), transform_gizmo_3d_model_from_constraint_and_mode_init(), WIDGETGROUP_gizmo_draw_prepare(), WIDGETGROUP_gizmo_refresh(), wm_gizmo_calculate_scale(), WM_gizmo_group_refresh(), WM_gizmo_target_property_subscribe_all(), wm_gizmogroup_free(), wm_gizmogroup_gizmo_register(), wm_gizmomap_modal_set(), WM_gizmomap_tooltip_init(), and wm_handlers_do_gizmo_handler().

◆ prev

wmGizmo * wmGizmo::prev

Definition at line 213 of file WM_gizmo_types.hh.

◆ properties

IDProperty* wmGizmo::properties

Definition at line 282 of file WM_gizmo_types.hh.

Referenced by wm_gizmo_create().

◆ ptr

PointerRNA* wmGizmo::ptr

Rna pointer to access properties.

Definition at line 231 of file WM_gizmo_types.hh.

Referenced by arrow_draw_geom(), arrow_draw_intern(), button2d_draw_intern(), dial_draw_intern(), dial_ghostarc_get_angles(), ED_view3d_gizmo_mesh_preselect_clear(), ED_view3d_gizmo_mesh_preselect_get_active(), gizmo2d_resize_setup(), gizmo2d_rotate_setup(), gizmo2d_xform_setup(), gizmo_arrow_exit(), gizmo_arrow_invoke(), gizmo_arrow_modal(), gizmo_arrow_property_update(), gizmo_arrow_test_select(), gizmo_button2d_cursor_get(), gizmo_cage2d_draw_intern(), gizmo_cage2d_modal(), gizmo_cage2d_test_select(), gizmo_cage2d_transform_flag_get(), gizmo_cage3d_draw_intern(), gizmo_cage3d_modal(), gizmo_dial_draw(), gizmo_dial_draw_select(), gizmo_dial_exit(), gizmo_dial_modal(), gizmo_empty_image_prop_matrix_get(), gizmo_empty_image_prop_matrix_set(), gizmo_mesh_bisect_setup(), gizmo_mesh_extrude_refresh(), gizmo_mesh_extrude_setup(), gizmo_mesh_placement_setup(), gizmo_mesh_spin_init_draw_prepare(), gizmo_mesh_spin_init_setup(), gizmo_mesh_spin_redo_setup(), gizmo_modal(), gizmo_move_invoke(), gizmo_preselect_edgering_test_select(), gizmo_preselect_elem_test_select(), gizmo_ruler_exit(), gizmo_ruler_invoke(), gizmo_spin_exec(), gizmogroup2d_init(), move3d_draw_intern(), move_geom_draw(), ringcut_invoke(), ruler_state_set(), tool_generic_create_gizmo(), blender::ed::view3d::geometry_nodes_gizmos::DialGizmo::update_style(), blender::ed::view3d::geometry_nodes_gizmos::LinearGizmo::update_style(), view3d_ruler_add_invoke(), view3d_ruler_item_mousemove(), WIDGETGROUP_armature_spline_setup(), WIDGETGROUP_camera_refresh(), WIDGETGROUP_camera_setup(), WIDGETGROUP_camera_view_refresh(), WIDGETGROUP_camera_view_setup(), WIDGETGROUP_empty_image_refresh(), WIDGETGROUP_empty_image_setup(), WIDGETGROUP_forcefield_setup(), WIDGETGROUP_light_area_refresh(), WIDGETGROUP_light_area_setup(), WIDGETGROUP_light_point_setup(), WIDGETGROUP_light_spot_setup(), WIDGETGROUP_light_target_setup(), WIDGETGROUP_navigate_setup(), WIDGETGROUP_navigate_setup(), blender::ed::space_node::WIDGETGROUP_node_corner_pin_setup(), blender::ed::space_node::WIDGETGROUP_node_crop_refresh(), blender::ed::space_node::WIDGETGROUP_node_crop_setup(), blender::ed::space_node::WIDGETGROUP_node_sbeam_setup(), blender::ed::space_node::WIDGETGROUP_node_transform_refresh(), blender::ed::space_node::WIDGETGROUP_node_transform_setup(), WIDGETGROUP_xform_cage_refresh(), WIDGETGROUP_xform_cage_setup(), WIDGETGROUP_xform_shear_setup(), wm_gizmo_create(), WM_gizmo_free(), and WM_gizmo_properties_reset().

◆ py_instance

void* wmGizmo::py_instance

Definition at line 228 of file WM_gizmo_types.hh.

Referenced by WM_gizmo_free().

◆ scale_basis

float wmGizmo::scale_basis

User defined scale, in addition to the original one.

Definition at line 269 of file WM_gizmo_types.hh.

Referenced by gizmo_init(), tool_generic_create_gizmo(), WIDGETGROUP_armature_spline_setup(), WIDGETGROUP_light_target_setup(), WIDGETGROUP_navigate_setup(), WIDGETGROUP_navigate_setup(), blender::ed::space_node::WIDGETGROUP_node_corner_pin_setup(), blender::ed::space_node::WIDGETGROUP_node_sbeam_setup(), wm_gizmo_calculate_scale(), and WM_gizmo_set_scale().

◆ scale_final

float wmGizmo::scale_final

Runtime property, set the scale while drawing on the viewport.

Definition at line 267 of file WM_gizmo_types.hh.

Referenced by gizmo_axis_draw(), gizmo_axis_test_select(), gizmo_button2d_test_select(), gizmo_calc_rect_view_margin(), gizmo_find_intersected_3d_intern(), gizmo_move_modal(), gizmo_move_test_select(), move_geom_draw(), WM_gizmo_calc_matrix_final_params(), and wm_gizmo_calculate_scale().

◆ select_bias

float wmGizmo::select_bias

Distance to bias this gizmo above others when picking (in world-space, scaled by the gizmo scale - when used).

Definition at line 250 of file WM_gizmo_types.hh.

Referenced by gizmo_draw_select_3d_loop(), gizmo_find_intersected_3d_intern(), and gizmo_mesh_extrude_setup().

◆ state

eWM_GizmoFlagState wmGizmo::state

State flags (active, highlighted, selected).

Definition at line 236 of file WM_gizmo_types.hh.

Referenced by dial_draw_intern(), ed_gizmo_draw_preset_geometry(), gizmo_arrow_draw(), gizmo_axis_draw(), gizmo_button2d_draw(), gizmo_cage2d_draw(), gizmo_cage3d_draw(), gizmo_dial_draw(), gizmo_mesh_spin_init_draw_prepare(), gizmo_move_draw(), gizmo_primitive_draw(), gizmo_select_invoke(), gizmo_tweak_start(), gizmos_draw_list(), snap_cursor_poll(), wm_gizmo_is_visible(), wm_gizmo_select_set_ex(), WM_gizmo_unlink(), wm_gizmomap_highlight_set(), and wm_gizmomap_modal_set().

◆ [union]

union { ... } wmGizmo::temp

Temporary data (assume dirty).

Referenced by WM_gizmo_cmp_temp_fl(), and WM_gizmo_cmp_temp_fl_reverse().

◆ type

const wmGizmoType* wmGizmo::type

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

Definition at line 216 of file WM_gizmo_types.hh.

Referenced by ED_view3d_gizmo_mesh_preselect_clear(), gizmo_draw_select_3d_loop(), gizmo_find_intersected_3d(), gizmo_tweak_finish(), gizmo_tweak_modal(), gizmo_update_prop_data(), gizmo_window_project_2d(), gizmo_window_project_3d(), gizmos_draw_list(), py_rna_gizmo_target_id_parse(), py_rna_gizmo_target_id_parse_and_ensure_is_valid(), py_rna_gizmo_target_type_id_parse(), transform_mode_snap_source_init(), UI_tooltip_create_from_gizmo(), ui_tooltip_data_from_gizmo(), WIDGETGROUP_camera_refresh(), WM_gizmo_calc_matrix_final_params(), wm_gizmo_calculate_scale(), wm_gizmo_create(), WM_gizmo_free(), WM_gizmo_new_ptr(), WM_gizmo_properties_reset(), wm_gizmo_select_set_ex(), wm_gizmo_target_property_array(), WM_gizmo_target_property_clear_rna(), WM_gizmo_target_property_def_func(), WM_gizmo_target_property_def_func_ptr(), WM_gizmo_target_property_def_rna(), WM_gizmo_target_property_def_rna_ptr(), WM_gizmo_target_property_find(), WM_gizmo_target_property_is_valid_any(), WM_gizmo_target_property_subscribe_all(), WM_gizmomap_cursor_set(), wm_gizmomap_highlight_set(), wm_gizmomap_modal_set(), and wm_gizmomaps_handled_modal_update().

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

WM_gizmo_types.hh