Blender  V3.3
Public Attributes | List of all members
wmGizmoType Struct Reference

#include <WM_gizmo_types.h>

Public Attributes

const char * idname
 
uint struct_size
 
wmGizmoFnSetup setup
 
wmGizmoFnDraw draw
 
wmGizmoFnDrawSelect draw_select
 
wmGizmoFnTestSelect test_select
 
wmGizmoFnModal modal
 
wmGizmoFnPropertyUpdate property_update
 
wmGizmoFnMatrixBasisGet matrix_basis_get
 
wmGizmoFnScreenBoundsGet screen_bounds_get
 
wmGizmoFnInvoke invoke
 
wmGizmoFnExit exit
 
wmGizmoFnCursorGet cursor_get
 
wmGizmoFnSelectRefresh select_refresh
 
wmGizmoFnFree free
 
struct StructRNAsrna
 
ExtensionRNA rna_ext
 
ListBase target_property_defs
 
int target_property_defs_len
 

Detailed Description

Definition at line 335 of file WM_gizmo_types.h.

Member Data Documentation

◆ cursor_get

wmGizmoFnCursorGet wmGizmoType::cursor_get

◆ draw

wmGizmoFnDraw wmGizmoType::draw

◆ draw_select

wmGizmoFnDrawSelect wmGizmoType::draw_select

Determines 3d intersection by rendering the gizmo in a selection routine.

Definition at line 350 of file WM_gizmo_types.h.

Referenced by gizmo_draw_select_3d_loop(), gizmo_find_intersected_3d(), GIZMO_GT_arrow_3d(), GIZMO_GT_button_2d(), GIZMO_GT_cage_2d(), GIZMO_GT_cage_3d(), GIZMO_GT_dial_3d(), GIZMO_GT_move_3d(), and GIZMO_GT_primitive_3d().

◆ exit

wmGizmoFnExit wmGizmoType::exit

Called when gizmo tweaking is done - used to free data and reset property when canceling.

Definition at line 382 of file WM_gizmo_types.h.

Referenced by GIZMO_GT_arrow_3d(), GIZMO_GT_cage_2d(), GIZMO_GT_cage_3d(), GIZMO_GT_dial_3d(), GIZMO_GT_move_3d(), gizmo_tweak_finish(), VIEW3D_GT_ruler_item(), and wm_gizmomaps_handled_modal_update().

◆ free

wmGizmoFnFree wmGizmoType::free

Free data (not the gizmo itself), use when the gizmo allocates its own members.

Definition at line 390 of file WM_gizmo_types.h.

Referenced by GIZMO_GT_button_2d(), GIZMO_GT_mesh_preselect_edgering_3d(), GIZMO_GT_mesh_preselect_elem_3d(), GIZMO_GT_snap_3d(), and WM_gizmo_free().

◆ idname

const char* wmGizmoType::idname

◆ invoke

wmGizmoFnInvoke wmGizmoType::invoke

◆ matrix_basis_get

wmGizmoFnMatrixBasisGet wmGizmoType::matrix_basis_get

Returns the final transformation which may be different from the 'matrix', depending on the gizmo. Notes:

Definition at line 368 of file WM_gizmo_types.h.

Referenced by GIZMO_GT_arrow_3d(), GIZMO_GT_move_3d(), WM_gizmo_calc_matrix_final_params(), and wm_gizmo_calculate_scale().

◆ modal

wmGizmoFnModal wmGizmoType::modal

◆ property_update

wmGizmoFnPropertyUpdate wmGizmoType::property_update

Gizmo-specific handler to update gizmo attributes based on the property value.

Definition at line 360 of file WM_gizmo_types.h.

Referenced by GIZMO_GT_arrow_3d(), GIZMO_GT_cage_2d(), GIZMO_GT_cage_3d(), GIZMO_GT_move_3d(), gizmo_update_prop_data(), WM_gizmo_target_property_def_func_ptr(), and WM_gizmo_target_property_def_rna_ptr().

◆ rna_ext

ExtensionRNA wmGizmoType::rna_ext

RNA integration.

Definition at line 396 of file WM_gizmo_types.h.

Referenced by gizmo_properties_init(), and WM_gizmotype_free_ptr().

◆ screen_bounds_get

wmGizmoFnScreenBoundsGet wmGizmoType::screen_bounds_get

Returns screen-space bounding box in the window space (compatible with wmEvent.xy).

Used for tool-tip placement (otherwise the cursor location is used).

Definition at line 376 of file WM_gizmo_types.h.

Referenced by GIZMO_GT_button_2d(), UI_tooltip_create_from_gizmo(), and VIEW3D_GT_navigate_rotate().

◆ select_refresh

wmGizmoFnSelectRefresh wmGizmoType::select_refresh

Called when gizmo selection state changes.

Definition at line 387 of file WM_gizmo_types.h.

Referenced by wm_gizmo_select_set_ex().

◆ setup

wmGizmoFnSetup wmGizmoType::setup

◆ srna

struct StructRNA* wmGizmoType::srna

◆ struct_size

uint wmGizmoType::struct_size

◆ target_property_defs

ListBase wmGizmoType::target_property_defs

◆ target_property_defs_len

int wmGizmoType::target_property_defs_len

◆ test_select

wmGizmoFnTestSelect wmGizmoType::test_select

Determine if the mouse intersects with the gizmo. The calculation should be done in the callback itself, -1 for no selection.

Definition at line 354 of file WM_gizmo_types.h.

Referenced by gizmo_find_intersected_3d(), GIZMO_GT_arrow_3d(), GIZMO_GT_blank_3d(), GIZMO_GT_button_2d(), GIZMO_GT_cage_2d(), GIZMO_GT_mesh_preselect_edgering_3d(), GIZMO_GT_mesh_preselect_elem_3d(), GIZMO_GT_move_3d(), GIZMO_GT_snap_3d(), VIEW3D_GT_navigate_rotate(), and VIEW3D_GT_ruler_item().


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