#include "MEM_guardedalloc.h"
#include "BLI_listbase.h"
#include "BLI_math.h"
#include "BKE_context.h"
#include "GPU_batch.h"
#include "RNA_access.h"
#include "RNA_define.h"
#include "RNA_prototypes.h"
#include "BKE_global.h"
#include "BKE_idprop.h"
#include "BKE_main.h"
#include "WM_api.h"
#include "WM_toolsystem.h"
#include "WM_types.h"
#include "ED_screen.h"
#include "ED_view3d.h"
#include "UI_interface.h"
#include "wm.h"
#include "wm_gizmo_intern.h"
#include "wm_gizmo_wmapi.h"

Functions
static void	wm_gizmo_register (wmGizmoGroup gzgroup, wmGizmo gz)

static wmGizmo *	wm_gizmo_create (const wmGizmoType gzt, PointerRNA properties)

wmGizmo *	WM_gizmo_new_ptr (const wmGizmoType gzt, wmGizmoGroup gzgroup, PointerRNA *properties)

wmGizmo *	WM_gizmo_new (const char idname, wmGizmoGroup gzgroup, PointerRNA *properties)

static void	gizmo_init (wmGizmo *gz)

void	WM_gizmo_free (wmGizmo *gz)

void	WM_gizmo_unlink (ListBase gizmolist, wmGizmoMap gzmap, wmGizmo gz, bContext C)

bool	wm_gizmo_select_set_ex (wmGizmoMap gzmap, wmGizmo gz, bool select, bool use_array, bool use_callback)

bool	WM_gizmo_select_unlink (wmGizmoMap gzmap, wmGizmo gz)

bool	WM_gizmo_select_set (wmGizmoMap gzmap, wmGizmo gz, bool select)

bool	WM_gizmo_highlight_set (wmGizmoMap gzmap, wmGizmo gz)

bool	wm_gizmo_select_and_highlight (bContext C, wmGizmoMap gzmap, wmGizmo *gz)

void	WM_gizmo_modal_set_from_setup (struct wmGizmoMap gzmap, struct bContext C, struct wmGizmo gz, int part_index, const wmEvent event)

void	wm_gizmo_calculate_scale (wmGizmo gz, const bContext C)

static void	gizmo_update_prop_data (wmGizmo *gz)

void	wm_gizmo_update (wmGizmo gz, const bContext C, const bool refresh_map)

int	wm_gizmo_is_visible (wmGizmo *gz)

void	WM_gizmo_calc_matrix_final_params (const wmGizmo gz, const struct WM_GizmoMatrixParams params, float r_mat[4][4])

void	WM_gizmo_calc_matrix_final_no_offset (const wmGizmo *gz, float r_mat[4][4])

void	WM_gizmo_calc_matrix_final (const wmGizmo *gz, float r_mat[4][4])

Gizmo Creation API
API for defining data on gizmo creation.
struct wmGizmoOpElem *	WM_gizmo_operator_get (wmGizmo *gz, int part_index)

PointerRNA *	WM_gizmo_operator_set (wmGizmo gz, int part_index, wmOperatorType ot, IDProperty *properties)

int	WM_gizmo_operator_invoke (bContext C, wmGizmo gz, wmGizmoOpElem gzop, const wmEvent event)

static void	wm_gizmo_set_matrix_rotation_from_z_axis__internal (float matrix[4][4], const float z_axis[3])

static void	wm_gizmo_set_matrix_rotation_from_yz_axis__internal (float matrix[4][4], const float y_axis[3], const float z_axis[3])

void	WM_gizmo_set_matrix_rotation_from_z_axis (wmGizmo *gz, const float z_axis[3])

void	WM_gizmo_set_matrix_rotation_from_yz_axis (wmGizmo *gz, const float y_axis[3], const float z_axis[3])

void	WM_gizmo_set_matrix_location (wmGizmo *gz, const float origin[3])

void	WM_gizmo_set_matrix_offset_rotation_from_z_axis (wmGizmo *gz, const float z_axis[3])

void	WM_gizmo_set_matrix_offset_rotation_from_yz_axis (wmGizmo *gz, const float y_axis[3], const float z_axis[3])

void	WM_gizmo_set_matrix_offset_location (wmGizmo *gz, const float offset[3])

void	WM_gizmo_set_flag (wmGizmo *gz, const int flag, const bool enable)

void	WM_gizmo_set_scale (wmGizmo *gz, const float scale)

void	WM_gizmo_set_line_width (wmGizmo *gz, const float line_width)

void	WM_gizmo_get_color (const wmGizmo *gz, float color[4])

void	WM_gizmo_set_color (wmGizmo *gz, const float color[4])

void	WM_gizmo_get_color_highlight (const wmGizmo *gz, float color_hi[4])

void	WM_gizmo_set_color_highlight (wmGizmo *gz, const float color_hi[4])

Gizmo Callback Assignment
void	WM_gizmo_set_fn_custom_modal (struct wmGizmo *gz, wmGizmoFnModal fn)

Gizmo Property Access
Matches `WM_operator_properties` conventions.
void	WM_gizmo_properties_create_ptr (PointerRNA ptr, wmGizmoType gzt)

void	WM_gizmo_properties_create (PointerRNA ptr, const char gtstring)

void	WM_gizmo_properties_alloc (PointerRNA ptr, IDProperty properties, const char *gtstring)

void	WM_gizmo_properties_sanitize (PointerRNA *ptr, const bool no_context)

bool	WM_gizmo_properties_default (PointerRNA *ptr, const bool do_update)

void	WM_gizmo_properties_reset (wmGizmo *gz)

void	WM_gizmo_properties_clear (PointerRNA *ptr)

void	WM_gizmo_properties_free (PointerRNA *ptr)

General Utilities
bool	WM_gizmo_context_check_drawstep (const struct bContext *C, eWM_GizmoFlagMapDrawStep step)

Function Documentation

◆ gizmo_init()

static void gizmo_init ( wmGizmo * gz )

static

Initialize default values and allocate needed memory for members.

Definition at line 103 of file wm_gizmo.c.

References wmGizmo::color, wmGizmo::color_hi, copy_v4_v4(), wmGizmo::line_width, and wmGizmo::scale_basis.

Referenced by wm_gizmo_register().

◆ gizmo_update_prop_data()

static void gizmo_update_prop_data ( wmGizmo * gz )

static

Definition at line 460 of file wm_gizmo.c.

References wmGizmoType::property_update, wmGizmoType::target_property_defs_len, wmGizmo::type, WM_gizmo_target_property_array(), and WM_gizmo_target_property_is_valid().

Referenced by wm_gizmo_update().

◆ WM_gizmo_calc_matrix_final()

void WM_gizmo_calc_matrix_final	(	const wmGizmo *	gz,
		float	r_mat[4][4]
	)

Definition at line 554 of file wm_gizmo.c.

References NULL, and WM_gizmo_calc_matrix_final_params().

Referenced by arrow_draw_intern(), button2d_draw_intern(), dial_draw_intern(), gizmo_arrow_invoke(), gizmo_arrow_test_select(), gizmo_button2d_bounds(), gizmo_cage2d_draw_intern(), gizmo_cage3d_draw_intern(), gizmo_move_invoke(), gizmo_primitive_draw_intern(), gizmo_primitive_invoke(), and move3d_draw_intern().

◆ WM_gizmo_calc_matrix_final_no_offset()

void WM_gizmo_calc_matrix_final_no_offset	(	const wmGizmo *	gz,
		float	r_mat[4][4]
	)

Definition at line 539 of file wm_gizmo.c.

References NULL, unit_m4(), and WM_gizmo_calc_matrix_final_params().

Referenced by button2d_draw_intern(), gizmo_button2d_bounds(), gizmo_cage2d_invoke(), and gizmo_calc_rect_view_scale().

◆ WM_gizmo_calc_matrix_final_params()

void WM_gizmo_calc_matrix_final_params	(	const wmGizmo *	gz,
		const struct WM_GizmoMatrixParams *	params,
		float	r_mat[4][4]
	)

◆ wm_gizmo_calculate_scale()

void wm_gizmo_calculate_scale	(	wmGizmo *	gz,
		const bContext *	C
	)

Definition at line 433 of file wm_gizmo.c.

References C, CTX_wm_region_view3d(), ED_view3d_pixel_size_no_ui_scale(), wmGizmoGroupType::flag, wmGizmo::matrix_basis, wmGizmoType::matrix_basis_get, wmGizmo::matrix_space, mul_m4_m4m4(), wmGizmo::parent_gzgroup, wmGizmo::scale_basis, wmGizmo::scale_final, wmGizmo::type, wmGizmoGroup::type, UI_DPI_FAC, and WM_GIZMOGROUPTYPE_SCALE.

Referenced by wm_gizmo_update().

◆ WM_gizmo_context_check_drawstep()

bool WM_gizmo_context_check_drawstep	(	const struct bContext *	C,
		eWM_GizmoFlagMapDrawStep	step
	)

Definition at line 704 of file wm_gizmo.c.

References C, CTX_wm_manager(), ED_screen_animation_playing(), WM_GIZMOMAP_DRAWSTEP_2D, and WM_GIZMOMAP_DRAWSTEP_3D.

Referenced by WM_gizmomap_draw(), and wm_gizmomap_highlight_find().

◆ wm_gizmo_create()

static wmGizmo* wm_gizmo_create	(	const wmGizmoType *	gzt,
		PointerRNA *	properties
	)

static

Note: Follow wm_operator_create convention.

Definition at line 50 of file wm_gizmo.c.

References BLI_assert, PointerRNA::data, wmGizmo::drag_part, G_MAIN, IDP_CopyProperty(), IDP_GROUP, IDP_New(), wmGizmo::matrix_basis, wmGizmo::matrix_offset, wmGizmo::matrix_space, MEM_callocN, NULL, wmGizmo::properties, wmGizmo::ptr, RNA_pointer_create(), wmGizmoType::srna, wmGizmoType::struct_size, wmGizmoType::target_property_defs_len, wmGizmo::type, unit_m4(), and WM_gizmo_properties_sanitize().

Referenced by WM_gizmo_new_ptr().

◆ WM_gizmo_free()

void WM_gizmo_free ( struct wmGizmo * gz )

Warning: this doesn't check wmGizmoMap (highlight, selection etc). Typical use is when freeing the windowing data, where caller can manage clearing selection, highlight... etc.

Definition at line 126 of file wm_gizmo.c.

References BPY_DECREF_RNA_INVALIDATE(), wmGizmoProperty::custom_func, wmGizmoType::free, wmGizmoProperty::free_fn, MEM_freeN, NULL, wmGizmo::op_data, wmGizmo::op_data_len, wmGizmoOpElem::ptr, wmGizmo::ptr, wmGizmo::py_instance, wmGizmoType::target_property_defs_len, wmGizmo::type, WM_gizmo_properties_free(), WM_gizmo_target_property_array(), and WM_operator_properties_free().

Referenced by WM_gizmo_unlink(), and wm_gizmogroup_free().

◆ WM_gizmo_get_color()

void WM_gizmo_get_color	(	const wmGizmo *	gz,
		float	color[4]
	)

Definition at line 324 of file wm_gizmo.c.

References color, wmGizmo::color, and copy_v4_v4().

◆ WM_gizmo_get_color_highlight()

void WM_gizmo_get_color_highlight	(	const wmGizmo *	gz,
		float	color_hi[4]
	)

Definition at line 333 of file wm_gizmo.c.

References wmGizmo::color_hi, and copy_v4_v4().

◆ WM_gizmo_highlight_set()

bool WM_gizmo_highlight_set	(	wmGizmoMap *	gzmap,
		wmGizmo *	gz
	)

Definition at line 402 of file wm_gizmo.c.

References wmGizmo::highlight_part, NULL, and wm_gizmomap_highlight_set().

Referenced by ED_screen_set_active_region(), view3d_ruler_add_invoke(), and WM_gizmo_modal_set_from_setup().

◆ wm_gizmo_is_visible()

int wm_gizmo_is_visible ( wmGizmo * gz )

Definition at line 482 of file wm_gizmo.c.

References wmGizmo::flag, wmGizmo::state, WM_GIZMO_DRAW_HOVER, WM_GIZMO_DRAW_MODAL, WM_GIZMO_DRAW_VALUE, WM_GIZMO_HIDDEN, WM_GIZMO_IS_VISIBLE_DRAW, WM_GIZMO_IS_VISIBLE_UPDATE, WM_GIZMO_STATE_HIGHLIGHT, WM_GIZMO_STATE_MODAL, and WM_GIZMO_STATE_SELECT.

Referenced by gizmo_prepare_drawing().

◆ WM_gizmo_modal_set_from_setup()

void WM_gizmo_modal_set_from_setup	(	struct wmGizmoMap *	gzmap,
		struct bContext *	C,
		struct wmGizmo *	gz,
		int	part_index,
		const wmEvent *	event
	)

Definition at line 416 of file wm_gizmo.c.

References C, wmGizmo::highlight_part, NULL, WM_gizmo_highlight_set(), wm_gizmomap_modal_set(), WM_OP_INVOKE_DEFAULT, and WM_operator_name_call().

Referenced by gizmo_mesh_placement_modal_from_setup(), and gizmo_mesh_spin_redo_modal_from_setup().

◆ WM_gizmo_new()

wmGizmo* WM_gizmo_new	(	const char *	idname,
		struct wmGizmoGroup *	gzgroup,
		struct PointerRNA *	properties
	)

Parameters

idname Must be a valid gizmo type name, if you need to check it exists use WM_gizmo_new_ptr because callers of this function don't NULL check the return value.

Definition at line 94 of file wm_gizmo.c.

References WM_gizmo_new_ptr(), and WM_gizmotype_find().

Referenced by tool_generic_create_gizmo(), WIDGETGROUP_camera_view_setup(), WIDGETGROUP_empty_image_setup(), WIDGETGROUP_forcefield_setup(), WIDGETGROUP_light_area_setup(), WIDGETGROUP_light_spot_setup(), WIDGETGROUP_light_target_setup(), WIDGETGROUP_navigate_setup(), blender::ed::space_node::WIDGETGROUP_node_crop_setup(), blender::ed::space_node::WIDGETGROUP_node_sbeam_setup(), and blender::ed::space_node::WIDGETGROUP_node_transform_setup().