wm_gizmo.cc File Reference

#include <new>
#include "MEM_guardedalloc.h"
#include "BLI_listbase.h"
#include "BLI_math_matrix.h"
#include "BKE_context.hh"
#include "GPU_batch.hh"
#include "RNA_access.hh"
#include "RNA_define.hh"
#include "RNA_prototypes.hh"
#include "BKE_global.hh"
#include "BKE_idprop.hh"
#include "BKE_main.hh"
#include "WM_api.hh"
#include "WM_toolsystem.hh"
#include "WM_types.hh"
#include "ED_screen.hh"
#include "ED_view3d.hh"
#include "wm_gizmo_intern.hh"
#include "wm_gizmo_wmapi.hh"

Go to the source code of this file.

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 (wmGizmoMap *gzmap, bContext *C, wmGizmo *gz, int part_index, const wmEvent *event)
void	WM_gizmo_modal_set_while_modal (wmGizmoMap *gzmap, bContext *C, wmGizmo *gz, 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 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.
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 (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 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.cc.

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 476 of file wm_gizmo.cc.

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 569 of file wm_gizmo.cc.

References params, 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 556 of file wm_gizmo.cc.

References params, 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 WM_GizmoMatrixParams *	params,
		float	r_mat[4][4] )

Definition at line 519 of file wm_gizmo.cc.

References copy_m4_m4(), wmGizmo::flag, float, wmGizmo::matrix_basis, wmGizmoType::matrix_basis_get, wmGizmo::matrix_offset, wmGizmo::matrix_space, mul_m4_m4m4(), mul_mat3_m4_fl(), params, wmGizmo::scale_final, wmGizmo::type, WM_GIZMO_DRAW_NO_SCALE, and WM_GIZMO_DRAW_OFFSET_SCALE.

Referenced by gizmo_axis_draw(), gizmo_calc_matrix_final_no_offset(), gizmo_window_project_2d(), gizmo_window_project_3d(), WM_gizmo_calc_matrix_final(), and WM_gizmo_calc_matrix_final_no_offset().

wm_gizmo_calculate_scale()

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

Definition at line 449 of file wm_gizmo.cc.

References 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_SCALE_FAC, and WM_GIZMOGROUPTYPE_SCALE.

Referenced by WM_gizmo_modal_set_while_modal(), and wm_gizmo_update().

WM_gizmo_context_check_drawstep()

bool WM_gizmo_context_check_drawstep	(	const bContext *	C,
		eWM_GizmoFlagMapDrawStep	step )

Definition at line 716 of file wm_gizmo.cc.

References 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 48 of file wm_gizmo.cc.

References BLI_assert, blender::bke::idprop::create_group(), PointerRNA::data, wmGizmo::drag_part, G_MAIN, IDP_CopyProperty(), wmGizmo::matrix_basis, wmGizmo::matrix_offset, wmGizmo::matrix_space, MEM_callocN, 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

(

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

References BPY_DECREF_RNA_INVALIDATE(), wmGizmoProperty::custom_func, wmGizmoType::free, wmGizmoProperty::free_fn, MEM_freeN(), wmGizmo::op_data, 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 323 of file wm_gizmo.cc.

References 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 332 of file wm_gizmo.cc.

References wmGizmo::color_hi, and copy_v4_v4().

WM_gizmo_highlight_set()

bool WM_gizmo_highlight_set	(	wmGizmoMap *	gzmap,
		wmGizmo *	gz )

Definition at line 401 of file wm_gizmo.cc.

References wmGizmo::highlight_part, and wm_gizmomap_highlight_set().

Referenced by ED_screen_set_active_region(), transform_gizmo_3d_model_from_constraint_and_mode_set(), 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 498 of file wm_gizmo.cc.

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	(	wmGizmoMap *	gzmap,
		bContext *	C,
		wmGizmo *	gz,
		int	part_index,
		const wmEvent *	event )

Special function to run from setup so gizmos start out interactive.

We could do this when linking them, but this complicates things since the window update code needs to run first.

Definition at line 415 of file wm_gizmo.cc.

References wmGizmo::highlight_part, 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_modal_set_while_modal()

void WM_gizmo_modal_set_while_modal	(	wmGizmoMap *	gzmap,
		bContext *	C,
		wmGizmo *	gz,
		const wmEvent *	event )

Replaces the current gizmo modal. The substitute gizmo start out interactive. It is similar to WM_gizmo_modal_set_from_setup but without operator initialization.

Definition at line 429 of file wm_gizmo.cc.

References wmGizmoMap::gzmap_context, wmGizmo::highlight_part, wmGizmoMap::modal, wm_gizmo_calculate_scale(), and wm_gizmomap_modal_set().

Referenced by transform_gizmo_3d_model_from_constraint_and_mode_set(), and transform_mode_snap_source_init().

WM_gizmo_new()

wmGizmo * WM_gizmo_new	(	const char *	idname,
		wmGizmoGroup *	gzgroup,
		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.cc.

References WM_gizmo_new_ptr(), and WM_gizmotype_find().

Referenced by blender::ed::view3d::geometry_nodes_gizmos::DialGizmo::create_gizmos(), blender::ed::view3d::geometry_nodes_gizmos::LinearGizmo::create_gizmos(), blender::ed::view3d::geometry_nodes_gizmos::TransformGizmos::create_gizmos(), tool_generic_create_gizmo(), WIDGETGROUP_camera_view_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_navigate_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().

WM_gizmo_new_ptr()

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

Definition at line 81 of file wm_gizmo.cc.

References wmGizmoType::setup, wmGizmo::type, wm_gizmo_create(), and wm_gizmo_register().

Referenced by gizmo_mesh_bisect_setup(), gizmo_mesh_extrude_setup(), gizmo_mesh_placement_setup(), gizmo_mesh_spin_init_setup(), gizmo_mesh_spin_redo_setup(), gizmogroup2d_init(), gizmogroup2d_resize_init(), gizmogroup2d_rotate_init(), ruler_item_add(), WIDGETGROUP_armature_spline_setup(), WIDGETGROUP_camera_setup(), WIDGETGROUP_mesh_preselect_edgering_setup(), WIDGETGROUP_mesh_preselect_elem_setup(), blender::ed::space_node::WIDGETGROUP_node_corner_pin_setup(), WIDGETGROUP_ruler_setup(), WIDGETGROUP_xform_cage_setup(), WIDGETGROUP_xform_shear_setup(), and WM_gizmo_new().

WM_gizmo_operator_get()

wmGizmoOpElem * WM_gizmo_operator_get	(	wmGizmo *	gz,
		int	part_index )

Definition at line 195 of file wm_gizmo.cc.

References wmGizmo::op_data.

Referenced by gizmo2d_resize_invoke_prepare(), gizmo2d_xform_invoke_prepare(), gizmo_mesh_extrude_invoke_prepare(), gizmo_mesh_extrude_setup(), gizmo_tweak_start_and_finish(), ui_tooltip_data_from_gizmo(), WIDGETGROUP_gizmo_invoke_prepare(), WIDGETGROUP_navigate_setup(), WIDGETGROUP_navigate_setup(), WIDGETGROUP_xform_cage_refresh(), WIDGETGROUP_xform_shear_refresh(), WIDGETGROUP_xform_shear_setup(), wm_gizmomap_modal_set(), and wm_gizmomaps_handled_modal_update().

WM_gizmo_operator_invoke()

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

Definition at line 227 of file wm_gizmo.cc.

References blender::bke::idprop::create_group(), PointerRNA::data, wmGizmo::flag, IDP_MergeGroup(), wmGizmoOpElem::ptr, wmGizmoOpElem::type, WM_GIZMO_OPERATOR_TOOL_INIT, WM_OP_INVOKE_DEFAULT, WM_operator_name_call_ptr(), WM_toolsystem_ref_from_context(), and WM_toolsystem_ref_properties_get_from_operator.

Referenced by gizmo_tweak_start_and_finish(), and wm_gizmomap_modal_set().

WM_gizmo_operator_set()

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

Definition at line 203 of file wm_gizmo.cc.

References BLI_assert, PointerRNA::data, wmGizmo::op_data, ot, wmGizmoOpElem::ptr, blender::Vector< T, InlineBufferCapacity, Allocator >::resize(), blender::Vector< T, InlineBufferCapacity, Allocator >::size(), wmGizmoOpElem::type, WM_operator_properties_create_ptr(), and WM_operator_properties_free().

Referenced by gizmo2d_resize_setup(), gizmo2d_rotate_setup(), gizmo2d_xform_setup(), gizmo_mesh_extrude_setup(), gizmo_mesh_spin_init_refresh_axis_orientation(), gizmogroup_init_properties_from_twtype(), WIDGETGROUP_light_target_setup(), WIDGETGROUP_navigate_setup(), WIDGETGROUP_navigate_setup(), WIDGETGROUP_ruler_setup(), WIDGETGROUP_xform_cage_setup(), and WIDGETGROUP_xform_shear_setup().

WM_gizmo_properties_alloc()

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

Similar to WM_gizmo_properties_create except its uses ID properties used for key-maps and macros.

Definition at line 603 of file wm_gizmo.cc.

References blender::bke::idprop::create_group(), ptr, and WM_gizmo_properties_create().

WM_gizmo_properties_clear()

void WM_gizmo_properties_clear

(

PointerRNA *

ptr

)

Definition at line 691 of file wm_gizmo.cc.

References PointerRNA::data, IDP_ClearProperty(), and ptr.

WM_gizmo_properties_create()

void WM_gizmo_properties_create	(	PointerRNA *	ptr,
		const char *	gtstring )

Definition at line 591 of file wm_gizmo.cc.

References ptr, RNA_pointer_create(), WM_gizmo_properties_create_ptr(), and WM_gizmotype_find().

Referenced by WM_gizmo_properties_alloc().

WM_gizmo_properties_create_ptr()

void WM_gizmo_properties_create_ptr	(	PointerRNA *	ptr,
		wmGizmoType *	gzt )

Definition at line 586 of file wm_gizmo.cc.

References ptr, RNA_pointer_create(), and wmGizmoType::srna.

Referenced by WM_gizmo_properties_create().

WM_gizmo_properties_default()

bool WM_gizmo_properties_default	(	PointerRNA *	ptr,
		bool	do_update )

Set all props to their default.

Parameters

do_update

Only update un-initialized props.

Note

There's nothing specific to gizmos here. This could be made a general function.

Definition at line 646 of file wm_gizmo.cc.

References PROP_POINTER, ptr, RNA_property_is_set(), RNA_property_pointer_get(), RNA_property_pointer_type(), RNA_property_reset(), RNA_property_type(), RNA_STRUCT_BEGIN, RNA_STRUCT_END, and WM_gizmo_properties_default().

Referenced by WM_gizmo_properties_default().

WM_gizmo_properties_free()

void WM_gizmo_properties_free

(

PointerRNA *

ptr

)

Definition at line 700 of file wm_gizmo.cc.

References PointerRNA::data, IDP_FreeProperty(), and ptr.

Referenced by WM_gizmo_free().

WM_gizmo_properties_reset()

void WM_gizmo_properties_reset

(

wmGizmo *

gz

)

Remove all props without PROP_SKIP_SAVE.

Definition at line 673 of file wm_gizmo.cc.

References PointerRNA::data, PROP_SKIP_SAVE, wmGizmo::ptr, RNA_PROP_BEGIN, RNA_PROP_END, RNA_property_flag(), RNA_property_identifier(), RNA_struct_idprops_unset(), RNA_struct_iterator_property(), wmGizmoType::srna, and wmGizmo::type.

WM_gizmo_properties_sanitize()

void WM_gizmo_properties_sanitize	(	PointerRNA *	ptr,
		const bool	no_context )

Definition at line 617 of file wm_gizmo.cc.

References PROP_ENUM, PROP_ENUM_NO_CONTEXT, PROP_POINTER, ptr, RNA_def_property_clear_flag(), RNA_def_property_flag(), RNA_property_pointer_get(), RNA_property_pointer_type(), RNA_property_type(), RNA_STRUCT_BEGIN, RNA_STRUCT_END, RNA_struct_is_a(), and WM_gizmo_properties_sanitize().

Referenced by wm_gizmo_create(), and WM_gizmo_properties_sanitize().

wm_gizmo_register()

static void wm_gizmo_register ( wmGizmoGroup * gzgroup, wmGizmo * gz )

static

Register gizmo.

Note

Not to be confused with type registration from RNA.

Definition at line 120 of file wm_gizmo.cc.

References gizmo_init(), and wm_gizmogroup_gizmo_register().

Referenced by WM_gizmo_new_ptr().

wm_gizmo_select_and_highlight()

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

Definition at line 406 of file wm_gizmo.cc.

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

Referenced by gizmo_select_invoke().

WM_gizmo_select_set()

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

Definition at line 396 of file wm_gizmo.cc.

References select(), and wm_gizmo_select_set_ex().

Referenced by gizmo_select_invoke(), wm_gizmo_select_and_highlight(), and wm_gizmomap_select_all_intern().

wm_gizmo_select_set_ex()

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

Add/Remove gizmo to selection. Reallocates memory for selected gizmos so better not call for selecting multiple ones.

Returns

if the selection has changed.

Definition at line 356 of file wm_gizmo.cc.

References select(), wmGizmoType::select_refresh, wmGizmo::state, wmGizmo::type, WM_GIZMO_STATE_SELECT, wm_gizmomap_select_array_push_back(), and wm_gizmomap_select_array_remove().

Referenced by WM_gizmo_select_set(), WM_gizmo_select_unlink(), and wm_gizmomap_deselect_all().

WM_gizmo_select_unlink()

bool WM_gizmo_select_unlink	(	wmGizmoMap *	gzmap,
		wmGizmo *	gz )

Remove from selection array without running callbacks.

Definition at line 391 of file wm_gizmo.cc.

References wm_gizmo_select_set_ex().

Referenced by WM_gizmo_unlink(), and wm_gizmogroup_free().

WM_gizmo_set_color()

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

Definition at line 327 of file wm_gizmo.cc.

References wmGizmo::color, and copy_v4_v4().

Referenced by gizmo2d_resize_setup(), gizmo2d_rotate_setup(), gizmo2d_xform_setup(), gizmo_mesh_spin_init_setup(), WIDGETGROUP_gizmo_draw_prepare(), and WIDGETGROUP_ruler_setup().

WM_gizmo_set_color_highlight()

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

Definition at line 336 of file wm_gizmo.cc.

References wmGizmo::color_hi, and copy_v4_v4().

Referenced by gizmo2d_resize_setup(), gizmo2d_rotate_setup(), gizmo2d_xform_setup(), gizmo_mesh_spin_init_setup(), and WIDGETGROUP_gizmo_draw_prepare().

WM_gizmo_set_flag()

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

Definition at line 303 of file wm_gizmo.cc.

References flag, and wmGizmo::flag.

Referenced by gizmo_3d_draw_invoke(), gizmo_3d_setup_draw_default(), gizmo_3d_setup_draw_from_twtype(), gizmo_3d_setup_draw_modal(), gizmo_mesh_bisect_setup(), gizmo_mesh_extrude_refresh(), gizmo_mesh_placement_setup(), gizmo_mesh_spin_init_draw_prepare(), gizmo_mesh_spin_init_refresh(), gizmo_mesh_spin_init_setup(), gizmo_mesh_spin_redo_setup(), gizmogroup_hide_all(), blender::ed::view3d::geometry_nodes_gizmos::NodeGizmos::hide_all(), ruler_item_add(), ruler_state_set(), blender::ed::view3d::geometry_nodes_gizmos::NodeGizmos::show_all(), blender::ed::view3d::geometry_nodes_gizmos::TransformGizmos::update_rotate_style(), blender::ed::view3d::geometry_nodes_gizmos::DialGizmo::update_style(), blender::ed::view3d::geometry_nodes_gizmos::DialGizmo::update_transform(), blender::ed::view3d::geometry_nodes_gizmos::TransformGizmos::update_translate_style(), blender::ed::view3d::geometry_nodes_gizmos::TransformGizmos::update_visibility(), WIDGETGROUP_armature_spline_setup(), WIDGETGROUP_camera_refresh(), WIDGETGROUP_camera_setup(), WIDGETGROUP_camera_view_refresh(), WIDGETGROUP_empty_image_setup(), WIDGETGROUP_forcefield_refresh(), WIDGETGROUP_forcefield_setup(), blender::ed::view3d::geometry_nodes_gizmos::WIDGETGROUP_geometry_nodes_refresh(), WIDGETGROUP_gizmo_draw_prepare(), WIDGETGROUP_light_area_setup(), WIDGETGROUP_light_point_setup(), WIDGETGROUP_light_spot_setup(), WIDGETGROUP_light_target_draw_prepare(), WIDGETGROUP_navigate_draw_prepare(), WIDGETGROUP_navigate_draw_prepare(), blender::ed::space_node::WIDGETGROUP_node_corner_pin_refresh(), blender::ed::space_node::WIDGETGROUP_node_crop_refresh(), blender::ed::space_node::WIDGETGROUP_node_sbeam_refresh(), blender::ed::space_node::WIDGETGROUP_node_transform_refresh(), WIDGETGROUP_tool_generic_refresh(), WIDGETGROUP_xform_cage_refresh(), WIDGETGROUP_xform_shear_refresh(), and WIDGETGROUP_xform_shear_setup().

WM_gizmo_set_fn_custom_modal()

void WM_gizmo_set_fn_custom_modal	(	wmGizmo *	gz,
		wmGizmoFnModal	fn )

Definition at line 347 of file wm_gizmo.cc.

References wmGizmo::custom_modal.

Referenced by gizmo2d_resize_setup(), gizmo2d_rotate_setup(), gizmo2d_xform_setup(), and gizmogroup_init_properties_from_twtype().

WM_gizmo_set_line_width()

void WM_gizmo_set_line_width	(	wmGizmo *	gz,
		const float	line_width )

Definition at line 318 of file wm_gizmo.cc.

References wmGizmo::line_width.

Referenced by gizmo2d_resize_setup(), gizmo2d_rotate_setup(), gizmo2d_xform_setup(), gizmo_3d_setup_draw_default(), gizmo_mesh_spin_init_setup(), gizmo_mesh_spin_redo_setup(), 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::DialGizmo::update_style(), blender::ed::view3d::geometry_nodes_gizmos::LinearGizmo::update_style(), and blender::ed::view3d::geometry_nodes_gizmos::TransformGizmos::update_translate_style().

WM_gizmo_set_matrix_location()

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

Definition at line 283 of file wm_gizmo.cc.

References copy_v3_v3(), and wmGizmo::matrix_basis.

Referenced by gizmo2d_modal(), gizmo2d_resize_draw_prepare(), gizmo2d_rotate_draw_prepare(), gizmo2d_xform_draw_prepare(), gizmo_mesh_bisect_update_from_op(), gizmo_mesh_extrude_refresh(), gizmo_mesh_spin_init_refresh(), gizmo_mesh_spin_redo_update_from_op(), gizmo_modal(), gizmo_refresh_from_matrix(), WIDGETGROUP_camera_refresh(), WIDGETGROUP_forcefield_refresh(), WIDGETGROUP_light_point_draw_prepare(), WIDGETGROUP_light_spot_draw_prepare(), WIDGETGROUP_light_spot_refresh(), blender::ed::space_node::WIDGETGROUP_node_transform_refresh(), WIDGETGROUP_xform_shear_draw_prepare(), and WIDGETGROUP_xform_shear_refresh().

WM_gizmo_set_matrix_offset_location()

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

Definition at line 298 of file wm_gizmo.cc.

References copy_v3_v3(), and wmGizmo::matrix_offset.

Referenced by gizmo2d_xform_draw_prepare(), gizmo2d_xform_setup(), gizmo_3d_setup_draw_modal(), WIDGETGROUP_camera_refresh(), and WIDGETGROUP_forcefield_refresh().

WM_gizmo_set_matrix_offset_rotation_from_yz_axis()

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

wmGizmo.matrix_offset utility, set the orientation by its Y/Z axis.

Definition at line 292 of file wm_gizmo.cc.

References wmGizmo::matrix_offset, and wm_gizmo_set_matrix_rotation_from_yz_axis__internal().

WM_gizmo_set_matrix_offset_rotation_from_z_axis()

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

wmGizmo.matrix_offset utility, set the orientation by its Z axis.

Definition at line 288 of file wm_gizmo.cc.

References wmGizmo::matrix_offset, and wm_gizmo_set_matrix_rotation_from_z_axis__internal().

WM_gizmo_set_matrix_rotation_from_yz_axis()

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

#wmGizmo.matrix utility, set the orientation by its Y/Z axis.

Definition at line 277 of file wm_gizmo.cc.

References wmGizmo::matrix_basis, and wm_gizmo_set_matrix_rotation_from_yz_axis__internal().

Referenced by gizmo_mesh_spin_init_refresh_axis_orientation(), gizmo_mesh_spin_redo_draw_prepare(), gizmo_mesh_spin_redo_update_from_op(), WIDGETGROUP_camera_refresh(), WIDGETGROUP_xform_shear_draw_prepare(), and WIDGETGROUP_xform_shear_refresh().

wm_gizmo_set_matrix_rotation_from_yz_axis__internal()

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] )

static

Definition at line 263 of file wm_gizmo.cc.

References cross_v3_v3v3(), normalize_v3(), and normalize_v3_v3().

Referenced by WM_gizmo_set_matrix_offset_rotation_from_yz_axis(), and WM_gizmo_set_matrix_rotation_from_yz_axis().

WM_gizmo_set_matrix_rotation_from_z_axis()

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

#wmGizmo.matrix utility, set the orientation by its Z axis.

Definition at line 273 of file wm_gizmo.cc.

References wmGizmo::matrix_basis, and wm_gizmo_set_matrix_rotation_from_z_axis__internal().

Referenced by gizmo2d_resize_draw_prepare(), gizmo2d_xform_setup(), gizmo_3d_draw_invoke(), gizmo_mesh_bisect_update_from_op(), gizmo_mesh_spin_init_refresh_axis_orientation(), gizmo_mesh_spin_redo_draw_prepare(), gizmo_mesh_spin_redo_update_from_op(), WIDGETGROUP_forcefield_refresh(), WIDGETGROUP_gizmo_draw_prepare(), WIDGETGROUP_light_point_draw_prepare(), WIDGETGROUP_light_spot_draw_prepare(), and WIDGETGROUP_light_spot_refresh().

wm_gizmo_set_matrix_rotation_from_z_axis__internal()

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

static

Definition at line 245 of file wm_gizmo.cc.

References copy_v3_v3(), normalize_v3_v3(), ortho_basis_v3v3_v3(), rot, and rotation_between_vecs_to_mat3().

Referenced by WM_gizmo_set_matrix_offset_rotation_from_z_axis(), and WM_gizmo_set_matrix_rotation_from_z_axis().

WM_gizmo_set_scale()

void WM_gizmo_set_scale	(	wmGizmo *	gz,
		const float	scale )

Definition at line 313 of file wm_gizmo.cc.

References wmGizmo::scale_basis.

Referenced by gizmo2d_resize_setup(), gizmo2d_rotate_setup(), gizmo2d_xform_setup(), gizmo_3d_setup_draw_default(), gizmo_mesh_bisect_update_from_op(), gizmo_mesh_extrude_setup(), gizmo_mesh_spin_init_setup(), gizmo_mesh_spin_redo_setup(), gizmo_refresh_from_matrix(), WIDGETGROUP_camera_refresh(), and WIDGETGROUP_camera_view_setup().

WM_gizmo_unlink()

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

Free gizmo and unlink from gizmolist. gizmolist is allowed to be NULL.

Definition at line 165 of file wm_gizmo.cc.

References BLI_assert, BLI_remlink(), wmGizmoMap::gzmap_context, wmGizmoMap::highlight, wmGizmoMap::modal, wmGizmo::state, WM_gizmo_free(), WM_gizmo_select_unlink(), WM_GIZMO_STATE_HIGHLIGHT, WM_GIZMO_STATE_MODAL, WM_GIZMO_STATE_SELECT, wm_gizmomap_highlight_set(), and wm_gizmomap_modal_set().

Referenced by gizmotype_unlink(), ruler_item_remove(), and blender::ed::view3d::geometry_nodes_gizmos::WIDGETGROUP_geometry_nodes_refresh().

wm_gizmo_update()

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

Definition at line 490 of file wm_gizmo.cc.

References gizmo_update_prop_data(), and wm_gizmo_calculate_scale().

Referenced by gizmo_prepare_drawing().