Blender V5.0
wmGizmo Struct Reference

#include <WM_gizmo_types.hh>

Public Attributes

wmGizmonext
wmGizmoprev
const wmGizmoTypetype
wmGizmoFnModal custom_modal
wmGizmoGroupparent_gzgroup
wmKeyMapkeymap
void * py_instance
PointerRNAptr
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
IDPropertyproperties
blender::Vector< wmGizmoProperty, 0 > target_properties
bool do_draw
union { 
   float   f 
temp

Detailed Description

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

Definition at line 214 of file WM_gizmo_types.hh.

Member Data Documentation

◆ color

◆ color_hi

◆ custom_modal

wmGizmoFnModal wmGizmo::custom_modal

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

Definition at line 222 of file WM_gizmo_types.hh.

Referenced by gizmo_dial_invoke(), gizmo_tweak_modal(), blender::ed::transform::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 291 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 248 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 295 of file WM_gizmo_types.hh.

Referenced by WM_gizmo_cmp_temp_fl(), and WM_gizmo_cmp_temp_fl_reverse().

◆ flag

◆ highlight_part

◆ interaction_data

◆ keymap

wmKeyMap* wmGizmo::keymap

◆ line_width

◆ matrix_basis

float wmGizmo::matrix_basis[4][4]

Transformation of this gizmo.

Definition at line 265 of file WM_gizmo_types.hh.

Referenced by button2d_draw_intern(), dial_draw_intern(), dial_ghostarc_get_angles(), blender::ed::transform::gizmo2d_xform_draw_prepare(), blender::ed::transform::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_modal(), 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(), gizmo_mesh_placement_modal_from_setup(), gizmo_mesh_spin_redo_setup(), gizmo_move_matrix_basis_get(), gizmo_placement_prop_matrix_get(), gizmo_placement_prop_matrix_set(), blender::ed::transform::gizmo_refresh_from_matrix(), 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::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(), 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(), blender::ed::transform::WIDGETGROUP_xform_shear_draw_prepare(), blender::ed::transform::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

◆ matrix_space

◆ next

wmGizmo* wmGizmo::next

Definition at line 215 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 282 of file WM_gizmo_types.hh.

Referenced by blender::ed::transform::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 225 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(), blender::ed::transform::gizmo_modal(), blender::ed::space_node::gizmo_node_box_mask_prop_matrix_get(), blender::ed::space_node::gizmo_node_box_mask_prop_matrix_set(), blender::ed::space_node::gizmo_node_crop_prop_matrix_get(), blender::ed::space_node::gizmo_node_crop_prop_matrix_set(), blender::ed::space_node::gizmo_node_split_prop_matrix_get(), blender::ed::space_node::gizmo_node_split_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(), blender::ed::transform::gizmogroup_xform_find(), gizmomap_prepare_drawing(), gizmos_draw_list(), snap_cursor_poll(), blender::ed::transform::transform_gizmo_3d_model_from_constraint_and_mode_init(), wm_gizmo_calculate_scale(), WM_gizmo_group_is_modal(), 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 215 of file WM_gizmo_types.hh.

◆ properties

IDProperty* wmGizmo::properties

Definition at line 284 of file WM_gizmo_types.hh.

Referenced by wm_gizmo_create().

◆ ptr

PointerRNA* wmGizmo::ptr

Rna pointer to access properties.

Definition at line 233 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(), 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(), 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(), blender::ed::transform::gizmo_mesh_extrude_refresh(), blender::ed::transform::gizmo_mesh_extrude_setup(), gizmo_mesh_placement_setup(), gizmo_mesh_spin_init_draw_prepare(), gizmo_mesh_spin_init_setup(), gizmo_mesh_spin_redo_setup(), blender::ed::transform::gizmo_modal(), gizmo_move_invoke(), gizmo_preselect_edgering_test_select(), gizmo_preselect_elem_test_select(), blender::ed::transform::gizmo_refresh_from_matrix(), gizmo_ruler_exit(), gizmo_ruler_invoke(), gizmo_spin_exec(), blender::ed::transform::gizmogroup2d_init(), move3d_draw_intern(), move_geom_draw(), ringcut_invoke(), ruler_state_set(), tool_generic_create_gizmo(), 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(), 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_box_mask_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_ellipse_mask_setup(), blender::ed::space_node::WIDGETGROUP_node_glare_setup(), blender::ed::space_node::WIDGETGROUP_node_mask_refresh(), blender::ed::space_node::WIDGETGROUP_node_split_refresh(), blender::ed::space_node::WIDGETGROUP_node_split_setup(), blender::ed::space_node::WIDGETGROUP_node_transform_refresh(), blender::ed::space_node::WIDGETGROUP_node_transform_setup(), WIDGETGROUP_ruler_setup(), blender::ed::transform::WIDGETGROUP_xform_cage_refresh(), blender::ed::transform::WIDGETGROUP_xform_cage_setup(), blender::ed::transform::WIDGETGROUP_xform_shear_setup(), wm_gizmo_create(), WM_gizmo_free(), and WM_gizmo_properties_reset().

◆ py_instance

void* wmGizmo::py_instance

Definition at line 230 of file WM_gizmo_types.hh.

Referenced by WM_gizmo_free().

◆ scale_basis

◆ scale_final

◆ 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 252 of file WM_gizmo_types.hh.

Referenced by blender::ed::transform::gizmo_3d_setup_draw_default(), blender::ed::transform::gizmo_3d_setup_draw_from_twtype(), gizmo_draw_select_3d_loop(), gizmo_find_intersected_3d_intern(), and blender::ed::transform::gizmo_mesh_extrude_setup().

◆ state

◆ target_properties

◆ [union]

union { ... } wmGizmo::temp

Temporary data (assume dirty).

Referenced by WM_gizmo_cmp_temp_fl(), and WM_gizmo_cmp_temp_fl_reverse().

◆ type


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