Blender: arrow3d_gizmo.c File Reference

Blender V2.93

#include "BLI_math.h"
#include "BLI_utildefines.h"
#include "DNA_view3d_types.h"
#include "BKE_context.h"
#include "GPU_immediate.h"
#include "GPU_immediate_util.h"
#include "GPU_matrix.h"
#include "GPU_select.h"
#include "GPU_state.h"
#include "MEM_guardedalloc.h"
#include "RNA_access.h"
#include "RNA_define.h"
#include "WM_api.h"
#include "WM_types.h"
#include "ED_gizmo_library.h"
#include "ED_screen.h"
#include "ED_view3d.h"
#include "UI_interface.h"
#include "../gizmo_geometry.h"
#include "../gizmo_library_intern.h"

Go to the source code of this file.

Classes
struct	ArrowGizmo3D

Functions
Arrow Gizmo API
void	ED_gizmo_arrow3d_set_ui_range (wmGizmo *gz, const float min, const float max)

void	ED_gizmo_arrow3d_set_range_fac (wmGizmo *gz, const float range_fac)

static void	GIZMO_GT_arrow_3d (wmGizmoType *gzt)

void	ED_gizmotypes_arrow_3d (void)

Arrow Gizmo
Simple arrow gizmo which is dragged into a certain direction. The arrow head can have varying shapes, e.g. cone, box, etc. 2D/3D Gizmo `matrix[0]` is derived from Y and Z. `matrix[1]` is 'up' for gizmo types that have an up. `matrix[2]` is the arrow direction (for all arrows).
typedef struct ArrowGizmo3D	ArrowGizmo3D

static void	gizmo_arrow_matrix_basis_get (const wmGizmo *gz, float r_matrix[4][4])

static void	arrow_draw_geom (const ArrowGizmo3D *arrow, const bool select, const float color[4])

static void	arrow_draw_intern (ArrowGizmo3D *arrow, const bool select, const bool highlight)

static void	gizmo_arrow_draw_select (const bContext UNUSED(C), wmGizmo gz, int select_id)

static void	gizmo_arrow_draw (const bContext UNUSED(C), wmGizmo gz)

static int	gizmo_arrow_test_select (bContext UNUSED(C), wmGizmo gz, const int mval[2])

static int	gizmo_arrow_modal (bContext C, wmGizmo gz, const wmEvent *event, eWM_GizmoFlagTweak tweak_flag)

static void	gizmo_arrow_setup (wmGizmo *gz)

static int	gizmo_arrow_invoke (bContext UNUSED(C), wmGizmo gz, const wmEvent *event)

static void	gizmo_arrow_property_update (wmGizmo gz, wmGizmoProperty gz_prop)

static void	gizmo_arrow_exit (bContext C, wmGizmo gz, const bool cancel)

Typedef Documentation

◆ ArrowGizmo3D

typedef struct ArrowGizmo3D ArrowGizmo3D

Function Documentation

◆ arrow_draw_geom()

static void arrow_draw_geom	(	const ArrowGizmo3D *	arrow,
		const bool	select,
		const float	color[4]
	)

static

Definition at line 84 of file arrow3d_gizmo.c.

References ARRAY_SIZE, BLI_assert, ED_GIZMO_ARROW_DRAW_FLAG_STEM, ED_GIZMO_ARROW_STYLE_BOX, ED_GIZMO_ARROW_STYLE_CONE, ED_GIZMO_ARROW_STYLE_CROSS, ED_GIZMO_ARROW_STYLE_NORMAL, ArrowGizmo3D::gizmo, GPU_COMP_F32, GPU_FETCH_FLOAT, GPU_matrix_pop(), GPU_matrix_push(), GPU_matrix_scale_3f(), GPU_matrix_translate_3f(), GPU_PRIM_LINE_LOOP, GPU_PRIM_LINE_STRIP, GPU_PRIM_LINES, GPU_SHADER_3D_POLYLINE_UNIFORM_COLOR, GPU_SHADER_3D_UNIFORM_COLOR, GPU_vertformat_attr_add(), GPU_viewport_size_get_f(), imm_draw_circle_fill_3d(), imm_draw_cylinder_fill_3d(), immBegin(), immBindBuiltinProgram(), immEnd(), immUnbindProgram(), immUniform1f(), immUniform2fv(), immUniformColor4fv(), immVertex3f(), immVertexFormat(), len, wmGizmo::line_width, pos, wmGizmo::ptr, RNA_enum_get(), RNA_float_get(), RNA_float_get_array(), select(), size(), width, wm_gizmo_geom_data_arrow, wm_gizmo_geom_data_cube, wm_gizmo_geometryinfo_draw(), and wm_gizmo_vec_draw().

Referenced by arrow_draw_intern().

◆ arrow_draw_intern()

static void arrow_draw_intern	(	ArrowGizmo3D *	arrow,
		const bool	select,
		const bool	highlight
	)

static

Definition at line 186 of file arrow3d_gizmo.c.

References arrow_draw_geom(), ArrowGizmo3D::gizmo, gizmo_color_get(), GPU_blend(), GPU_BLEND_ALPHA, GPU_BLEND_NONE, GPU_matrix_mul, GPU_matrix_pop(), GPU_matrix_push(), GizmoInteraction::init_matrix_final, wmGizmo::interaction_data, select(), and WM_gizmo_calc_matrix_final().

Referenced by gizmo_arrow_draw(), and gizmo_arrow_draw_select().

◆ ED_gizmo_arrow3d_set_range_fac()

void ED_gizmo_arrow3d_set_range_fac	(	wmGizmo *	gz,
		const float	range_fac
	)

Define a custom factor for arrow min/max distance

Note: Needs to be called before WM_gizmo_target_property_def_rna!

Definition at line 475 of file arrow3d_gizmo.c.

References BLI_assert, ArrowGizmo3D::data, GizmoCommonData::range_fac, WM_gizmo_target_property_find(), and WM_gizmo_target_property_is_valid().

Referenced by WIDGETGROUP_camera_refresh(), WIDGETGROUP_forcefield_setup(), and WIDGETGROUP_light_spot_setup().

◆ ED_gizmo_arrow3d_set_ui_range()

void ED_gizmo_arrow3d_set_ui_range	(	wmGizmo *	gz,
		const float	min,
		const float	max
	)

Define a custom property UI range

Note: Needs to be called before WM_gizmo_target_property_def_rna!

Definition at line 456 of file arrow3d_gizmo.c.

References BLI_assert, ArrowGizmo3D::data, GizmoCommonData::is_custom_range_set, GizmoCommonData::max, max, min, GizmoCommonData::min, GizmoCommonData::range, WM_gizmo_target_property_find(), and WM_gizmo_target_property_is_valid().

Referenced by WIDGETGROUP_forcefield_setup().

◆ ED_gizmotypes_arrow_3d()

void ED_gizmotypes_arrow_3d ( void )

Definition at line 541 of file arrow3d_gizmo.c.

References GIZMO_GT_arrow_3d(), and WM_gizmotype_append().

Referenced by ED_spacetypes_init().

◆ gizmo_arrow_draw()

static void gizmo_arrow_draw	(	const bContext *	UNUSEDC,
		wmGizmo *	gz
	)

static

Definition at line 224 of file arrow3d_gizmo.c.

References arrow_draw_intern(), wmGizmo::state, and WM_GIZMO_STATE_HIGHLIGHT.

Referenced by GIZMO_GT_arrow_3d().

◆ gizmo_arrow_draw_select()

static void gizmo_arrow_draw_select	(	const bContext *	UNUSEDC,
		wmGizmo *	gz,
		int	select_id
	)

static

Definition at line 218 of file arrow3d_gizmo.c.

References arrow_draw_intern(), and GPU_select_load_id().

Referenced by GIZMO_GT_arrow_3d().

◆ gizmo_arrow_exit()

static void gizmo_arrow_exit	(	bContext *	C,
		wmGizmo *	gz,
		const bool	cancel
	)

static

Definition at line 414 of file arrow3d_gizmo.c.

References C, data, ArrowGizmo3D::data, ED_GIZMO_ARROW_XFORM_FLAG_CONSTRAINED, ED_GIZMO_ARROW_XFORM_FLAG_INVERTED, ArrowGizmo3D::gizmo, gizmo_offset_from_value(), gizmo_property_value_reset(), GizmoInteraction::init_offset, wmGizmo::interaction_data, wmGizmo::ptr, RNA_enum_get(), WM_gizmo_target_property_anim_autokey(), WM_gizmo_target_property_find(), WM_gizmo_target_property_float_get(), and WM_gizmo_target_property_is_valid().

Referenced by GIZMO_GT_arrow_3d().

◆ gizmo_arrow_invoke()

static int gizmo_arrow_invoke	(	bContext *	UNUSEDC,
		wmGizmo *	gz,
		const wmEvent *	event
	)

static

Definition at line 381 of file arrow3d_gizmo.c.

References ArrowGizmo3D::data, gizmo_arrow_matrix_basis_get(), GizmoInteraction::init_matrix_basis, GizmoInteraction::init_matrix_final, GizmoInteraction::init_mval, GizmoInteraction::init_offset, GizmoInteraction::init_value, wmGizmo::interaction_data, MEM_callocN, GizmoCommonData::offset, OPERATOR_RUNNING_MODAL, WM_gizmo_calc_matrix_final(), WM_gizmo_target_property_find(), WM_gizmo_target_property_float_get(), and WM_gizmo_target_property_is_valid().

Referenced by GIZMO_GT_arrow_3d().

◆ gizmo_arrow_matrix_basis_get()

static void gizmo_arrow_matrix_basis_get	(	const wmGizmo *	gz,
		float	r_matrix[4][4]
	)

static

Definition at line 76 of file arrow3d_gizmo.c.

References copy_m4_m4(), ArrowGizmo3D::data, ArrowGizmo3D::gizmo, madd_v3_v3fl(), wmGizmo::matrix_basis, and GizmoCommonData::offset.

Referenced by gizmo_arrow_invoke(), and GIZMO_GT_arrow_3d().

◆ gizmo_arrow_modal()

static int gizmo_arrow_modal	(	bContext *	C,
		wmGizmo *	gz,
		const wmEvent *	event,
		eWM_GizmoFlagTweak	tweak_flag
	)

static

Calculate arrow offset independent from prop min value, meaning the range will not be offset by min value first.

Definition at line 277 of file arrow3d_gizmo.c.

References acosf, C, copy_v3_v3(), CTX_wm_region(), CTX_wm_window(), data, ArrowGizmo3D::data, dot_v3v3(), ED_GIZMO_ARROW_XFORM_FLAG_CONSTRAINED, ED_GIZMO_ARROW_XFORM_FLAG_INVERTED, ED_region_tag_redraw_editor_overlays(), ED_view3d_win_to_ray(), ArrowGizmo3D::gizmo, gizmo_offset_from_value(), gizmo_value_from_offset(), GizmoInteraction::init_matrix_basis, GizmoInteraction::init_mval, wmGizmo::interaction_data, isect_ray_plane_v3(), len_v3(), madd_v3_v3v3fl(), wmGizmo::matrix_basis, MOUSEMOVE, wmEvent::mval, normalize_v3(), normalize_v3_v3(), OPERATOR_RUNNING_MODAL, plane_from_point_normal_v3(), project_plane_v3_v3v3(), wmGizmo::ptr, RAD2DEGF, ARegion::regiondata, RNA_enum_get(), sub_v3_v3v3(), wmEvent::type, UNPACK2, RegionView3D::viewinv, WM_event_add_mousemove(), WM_gizmo_target_property_find(), WM_gizmo_target_property_float_get(), WM_gizmo_target_property_float_set(), WM_gizmo_target_property_is_valid(), and WM_GIZMO_TWEAK_PRECISE.

Referenced by GIZMO_GT_arrow_3d().

◆ gizmo_arrow_property_update()

static void gizmo_arrow_property_update	(	wmGizmo *	gz,
		wmGizmoProperty *	gz_prop
	)

static

Definition at line 405 of file arrow3d_gizmo.c.

References ArrowGizmo3D::data, ED_GIZMO_ARROW_XFORM_FLAG_CONSTRAINED, ED_GIZMO_ARROW_XFORM_FLAG_INVERTED, ArrowGizmo3D::gizmo, gizmo_property_data_update(), wmGizmo::ptr, and RNA_enum_get().

Referenced by GIZMO_GT_arrow_3d().

◆ gizmo_arrow_setup()

static void gizmo_arrow_setup ( wmGizmo * gz )

static

Definition at line 372 of file arrow3d_gizmo.c.

References ArrowGizmo3D::data, wmGizmo::flag, ArrowGizmo3D::gizmo, GizmoCommonData::range_fac, and WM_GIZMO_DRAW_MODAL.

Referenced by GIZMO_GT_arrow_3d().

◆ gizmo_arrow_test_select()

static int gizmo_arrow_test_select	(	bContext *	UNUSEDC,
		wmGizmo *	gz,
		const int	mval[2]
	)

static

Selection for 2D views.

Definition at line 232 of file arrow3d_gizmo.c.

References closest_to_line_v2(), copy_v2_v2(), ArrowGizmo3D::gizmo, len_squared_v2v2(), mul_m4_v3(), wmGizmo::ptr, RNA_float_get(), square_f(), UI_DPI_FAC, UNPACK2, and WM_gizmo_calc_matrix_final().

Referenced by GIZMO_GT_arrow_3d().

◆ GIZMO_GT_arrow_3d()

static void GIZMO_GT_arrow_3d ( wmGizmoType * gzt )

static

Definition at line 484 of file arrow3d_gizmo.c.

References wmGizmoType::draw, wmGizmoType::draw_select, ED_GIZMO_ARROW_DRAW_FLAG_STEM, ED_GIZMO_ARROW_STYLE_BOX, ED_GIZMO_ARROW_STYLE_CONE, ED_GIZMO_ARROW_STYLE_CROSS, ED_GIZMO_ARROW_STYLE_NORMAL, ED_GIZMO_ARROW_XFORM_FLAG_CONSTRAINED, ED_GIZMO_ARROW_XFORM_FLAG_INVERTED, wmGizmoType::exit, gizmo_arrow_draw(), gizmo_arrow_draw_select(), gizmo_arrow_exit(), gizmo_arrow_invoke(), gizmo_arrow_matrix_basis_get(), gizmo_arrow_modal(), gizmo_arrow_property_update(), gizmo_arrow_setup(), gizmo_arrow_test_select(), wmGizmoType::idname, wmGizmoType::invoke, wmGizmoType::matrix_basis_get, wmGizmoType::modal, NULL, PROP_FLOAT, wmGizmoType::property_update, RNA_def_enum(), RNA_def_enum_flag(), RNA_def_float(), RNA_def_float_vector(), wmGizmoType::setup, wmGizmoType::srna, wmGizmoType::struct_size, wmGizmoType::test_select, and WM_gizmotype_target_property_def().

Referenced by ED_gizmotypes_arrow_3d().