#include <WM_gizmo_types.h>

Public Attributes
struct wmGizmo *	next

struct wmGizmo *	prev

const struct wmGizmoType *	type

wmGizmoFnModal	custom_modal

struct wmGizmoGroup *	parent_gzgroup

struct wmKeyMap *	keymap

void *	py_instance

struct 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

wmGizmoOpElem *	op_data

int	op_data_len

struct IDProperty *	properties

bool	do_draw

union {
float f

}	temp

Detailed Description

Definition at line 210 of file WM_gizmo_types.h.

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.h.

◆ 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 218 of file WM_gizmo_types.h.

Referenced by gizmo_tweak_modal(), 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 286 of file WM_gizmo_types.h.

◆ 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 244 of file WM_gizmo_types.h.

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

◆ f

float wmGizmo::f

Definition at line 290 of file WM_gizmo_types.h.

Referenced by WIDGETGROUP_xform_shear_draw_prepare(), 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 232 of file WM_gizmo_types.h.

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_primitive_setup(), gizmogroup_init(), move_geom_draw(), snap_gizmo_setup(), tool_generic_create_gizmo(), WIDGETGROUP_camera_setup(), WIDGETGROUP_navigate_setup(), WIDGETGROUP_placement_setup(), WM_gizmo_calc_matrix_final_params(), wm_gizmo_is_visible(), WM_gizmo_operator_invoke(), WM_gizmo_set_flag(), WM_gizmomap_message_subscribe(), 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 238 of file WM_gizmo_types.h.

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(), ui_tooltip_data_from_gizmo(), view3d_ruler_add_invoke(), WM_gizmo_highlight_set(), WM_gizmo_modal_set_from_setup(), 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

struct wmKeyMap* wmGizmo::keymap

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

Definition at line 224 of file WM_gizmo_types.h.

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.h.

Referenced by arrow_draw_geom(), button2d_draw_intern(), button2d_geom_draw_backdrop(), dial_draw_intern(), gizmo_cage2d_draw_intern(), gizmo_cage3d_draw_intern(), gizmo_init(), gizmo_mesh_extrude_setup(), 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.h.

Referenced by button2d_draw_intern(), dial_draw_intern(), dial_ghostarc_get_angles(), 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_move_matrix_basis_get(), 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(), WIDGETGROUP_armature_spline_setup(), WIDGETGROUP_camera_refresh(), WIDGETGROUP_empty_image_refresh(), WIDGETGROUP_light_area_refresh(), WIDGETGROUP_light_target_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.h.

Referenced by gizmo2d_xform_draw_prepare(), 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_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(), 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]

Transformation of the gizmo in 2d or 3d space.

Matrix axis are expected to be unit length (scale is applied after).
Behavior when axis aren't orthogonal depends on each gizmo.
Typically the +Z is the primary axis for gizmos to use.
'matrix[3]' must be used for location, besides this it's up to the gizmos internal code how the rotation components are used for drawing and interaction. The space this gizmo is being modified in.

Definition at line 261 of file WM_gizmo_types.h.

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

◆ next

struct wmGizmo* wmGizmo::next

Definition at line 211 of file WM_gizmo_types.h.

Referenced by gizmos_draw_list(), and view3d_ruler_to_gpencil().

◆ op_data

wmGizmoOpElem* 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.h.

Referenced by 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().

◆ op_data_len

int wmGizmo::op_data_len

Definition at line 281 of file WM_gizmo_types.h.

Referenced by WM_gizmo_free(), and WM_gizmo_operator_set().

◆ parent_gzgroup

struct wmGizmoGroup* wmGizmo::parent_gzgroup

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

Definition at line 221 of file WM_gizmo_types.h.

◆ prev

struct wmGizmo * wmGizmo::prev

Definition at line 211 of file WM_gizmo_types.h.

◆ properties

struct IDProperty* wmGizmo::properties

Definition at line 283 of file WM_gizmo_types.h.

Referenced by wm_gizmo_create().

◆ ptr

struct PointerRNA* wmGizmo::ptr

Rna pointer to access properties.

Definition at line 229 of file WM_gizmo_types.h.

◆ py_instance

void* wmGizmo::py_instance

Definition at line 226 of file WM_gizmo_types.h.

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.h.

Referenced by gizmo_init(), tool_generic_create_gizmo(), WIDGETGROUP_armature_spline_setup(), WIDGETGROUP_light_target_setup(), WIDGETGROUP_navigate_setup(), WIDGETGROUP_node_corner_pin_setup(), 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.h.

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 248 of file WM_gizmo_types.h.

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

◆ state

eWM_GizmoFlagState wmGizmo::state

State flags (active, highlighted, selected)

Definition at line 234 of file WM_gizmo_types.h.

Referenced by ED_gizmo_draw_preset_facemap(), 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_mesh_spin_redo_draw_prepare(), gizmo_move_draw(), gizmo_primitive_draw(), gizmo_select_invoke(), gizmo_tweak_start(), gizmos_draw_list(), idp_snap_point_from_gizmo_ex(), wm_gizmo_is_visible(), wm_gizmo_select_set_ex(), WM_gizmo_unlink(), wm_gizmomap_highlight_set(), and wm_gizmomap_modal_set().

◆

union { ... } wmGizmo::temp

Temporary data (assume dirty).