Blender V4.3
Classes | Enumerations | Functions
wm_gizmo_intern.hh File Reference
Blender » GUI » Window Manager
#include "wm_gizmo_fn.hh"

Go to the source code of this file.

Classes

struct  wmGizmoMapSelectState
 
struct  wmGizmoMap
 
struct  wmGizmoMapType
 

Enumerations

enum  { WM_GIZMO_IS_VISIBLE_UPDATE = (1 << 0) , WM_GIZMO_IS_VISIBLE_DRAW = (1 << 1) }
 
enum  {
  TWEAK_MODAL_CANCEL = 1 , TWEAK_MODAL_CONFIRM , TWEAK_MODAL_PRECISION_ON , TWEAK_MODAL_PRECISION_OFF ,
  TWEAK_MODAL_SNAP_ON , TWEAK_MODAL_SNAP_OFF
}
 

Functions

bool wm_gizmo_select_set_ex (wmGizmoMap *gzmap, wmGizmo *gz, bool select, bool use_array, bool use_callback)
 
bool wm_gizmo_select_and_highlight (bContext *C, wmGizmoMap *gzmap, wmGizmo *gz)
 
void wm_gizmo_calculate_scale (wmGizmo *gz, const bContext *C)
 
void wm_gizmo_update (wmGizmo *gz, const bContext *C, bool refresh_map)
 
int wm_gizmo_is_visible (wmGizmo *gz)
 
wmGizmoGroup * wm_gizmogroup_new_from_type (wmGizmoMap *gzmap, wmGizmoGroupType *gzgt)
 
void wm_gizmogroup_free (bContext *C, wmGizmoGroup *gzgroup)
 
void wm_gizmogroup_gizmo_register (wmGizmoGroup *gzgroup, wmGizmo *gz)
 
wmGizmoGroup * wm_gizmogroup_find_by_type (const wmGizmoMap *gzmap, const wmGizmoGroupType *gzgt)
 
wmGizmo * wm_gizmogroup_find_intersected_gizmo (wmWindowManager *wm, const wmGizmoGroup *gzgroup, bContext *C, int event_modifier, const int mval[2], int *r_part)
 
void wm_gizmogroup_intersectable_gizmos_to_list (wmWindowManager *wm, const wmGizmoGroup *gzgroup, int event_modifier, BLI_Buffer *visible_gizmos)
 
bool wm_gizmogroup_is_visible_in_drawstep (const wmGizmoGroup *gzgroup, eWM_GizmoFlagMapDrawStep drawstep)
 
void wm_gizmogrouptype_setup_keymap (wmGizmoGroupType *gzgt, wmKeyConfig *keyconf)
 
wmKeyMap * wm_gizmogroup_tweak_modal_keymap (wmKeyConfig *keyconf)
 
void wm_gizmomap_select_array_clear (wmGizmoMap *gzmap)
 
bool wm_gizmomap_deselect_all (wmGizmoMap *gzmap)
 
void wm_gizmomap_select_array_shrink (wmGizmoMap *gzmap, int len_subtract)
 
void wm_gizmomap_select_array_push_back (wmGizmoMap *gzmap, wmGizmo *gz)
 
void wm_gizmomap_select_array_remove (wmGizmoMap *gzmap, wmGizmo *gz)
 

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
WM_GIZMO_IS_VISIBLE_UPDATE 
WM_GIZMO_IS_VISIBLE_DRAW 

Definition at line 34 of file wm_gizmo_intern.hh.

◆ anonymous enum

anonymous enum
Enumerator
TWEAK_MODAL_CANCEL 
TWEAK_MODAL_CONFIRM 
TWEAK_MODAL_PRECISION_ON 
TWEAK_MODAL_PRECISION_OFF 
TWEAK_MODAL_SNAP_ON 
TWEAK_MODAL_SNAP_OFF 

Definition at line 42 of file wm_gizmo_intern.hh.

Function Documentation

◆ 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_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_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_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_update()

void wm_gizmo_update ( wmGizmo * gz,
const bContext * C,
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().

◆ wm_gizmogroup_find_by_type()

wmGizmoGroup * wm_gizmogroup_find_by_type ( const wmGizmoMap * gzmap,
const wmGizmoGroupType * gzgt )

Definition at line 67 of file wm_gizmo_group.cc.

References BLI_findptr(), wmGizmoMap::groups, and offsetof.

◆ wm_gizmogroup_find_intersected_gizmo()

wmGizmo * wm_gizmogroup_find_intersected_gizmo ( wmWindowManager * wm,
const wmGizmoGroup * gzgroup,
bContext * C,
int event_modifier,
const int mval[2],
int * r_part )

Definition at line 187 of file wm_gizmo_group.cc.

References wmGizmoGroup::gizmos, LISTBASE_FOREACH, WM_GIZMO_HIDDEN, WM_GIZMO_HIDDEN_SELECT, and wm_gizmo_keymap_uses_event_modifier().

Referenced by wm_gizmomap_highlight_find().

◆ wm_gizmogroup_free()

void wm_gizmogroup_free ( bContext * C,
wmGizmoGroup * gzgroup )

Definition at line 73 of file wm_gizmo_group.cc.

References BLI_listbase_clear(), BLI_remlink(), BPY_DECREF_RNA_INVALIDATE(), wmGizmoGroup::customdata, wmGizmoGroup::customdata_free, ListBase::first, wmGizmoGroup::gizmos, wmGizmoMap::groups, wmGizmoMap::gzmap_context, wmGizmoMap::highlight, wmGizmoMapSelectState::len, MEM_freeN(), MEM_SAFE_FREE, wmGizmoMap::modal, wmGizmo::parent_gzgroup, wmGizmoGroup::parent_gzmap, wmGizmoGroup::py_instance, wmGizmoMap::select, wmGizmoGroup::tag_remove, wmGizmoGroup::type, wmGizmoGroupType::users, WM_gizmo_free(), WM_gizmo_select_unlink(), wm_gizmomap_highlight_set(), and wm_gizmomap_modal_set().

Referenced by WM_gizmo_group_remove_by_tool(), WM_gizmoconfig_update(), wm_gizmomap_free_data(), and WM_gizmomaptype_group_unlink().

◆ wm_gizmogroup_gizmo_register()

void wm_gizmogroup_gizmo_register ( wmGizmoGroup * gzgroup,
wmGizmo * gz )

Add gizmo to gzgroup and make sure its name is unique within the group.

Definition at line 130 of file wm_gizmo_group.cc.

References BLI_addtail(), BLI_assert, BLI_findindex(), wmGizmoGroup::gizmos, and wmGizmo::parent_gzgroup.

Referenced by wm_gizmo_register().

◆ wm_gizmogroup_intersectable_gizmos_to_list()

void wm_gizmogroup_intersectable_gizmos_to_list ( wmWindowManager * wm,
const wmGizmoGroup * gzgroup,
int event_modifier,
BLI_Buffer * visible_gizmos )

Adds all gizmos of gzgroup that can be selected to the head of listbase. Added items need freeing!

Definition at line 214 of file wm_gizmo_group.cc.

References BLI_buffer_append, wmGizmoGroupType::flag, wmGizmoGroup::gizmos, LISTBASE_FOREACH_BACKWARD, wmGizmoGroup::type, WM_GIZMO_HIDDEN, WM_GIZMO_HIDDEN_SELECT, wm_gizmo_keymap_uses_event_modifier(), and WM_GIZMOGROUPTYPE_3D.

Referenced by wm_gizmomap_highlight_find().

◆ wm_gizmogroup_is_visible_in_drawstep()

bool wm_gizmogroup_is_visible_in_drawstep ( const wmGizmoGroup * gzgroup,
eWM_GizmoFlagMapDrawStep drawstep )

Definition at line 298 of file wm_gizmo_group.cc.

References BLI_assert_unreachable, wmGizmoGroupType::flag, wmGizmoGroup::type, WM_GIZMOGROUPTYPE_3D, WM_GIZMOMAP_DRAWSTEP_2D, and WM_GIZMOMAP_DRAWSTEP_3D.

Referenced by gizmomap_prepare_drawing(), and wm_gizmomap_modal_set().

◆ wm_gizmogroup_new_from_type()

wmGizmoGroup * wm_gizmogroup_new_from_type ( wmGizmoMap * gzmap,
wmGizmoGroupType * gzgt )

Create a new gizmo-group from gzgt.

Definition at line 51 of file wm_gizmo_group.cc.

References BLI_addtail(), wmGizmoMap::groups, MEM_callocN, wmGizmoGroup::parent_gzmap, wmGizmoGroup::type, and wmGizmoGroupType::users.

Referenced by wm_gizmomap_new_from_type_ex(), and WM_gizmomaptype_group_init_runtime_with_region().

◆ wm_gizmogroup_tweak_modal_keymap()

wmKeyMap * wm_gizmogroup_tweak_modal_keymap ( wmKeyConfig * keyconf)

Definition at line 631 of file wm_gizmo_group.cc.

References EVT_ESCKEY, EVT_LEFTCTRLKEY, EVT_LEFTSHIFTKEY, EVT_PADENTER, EVT_RETKEY, EVT_RIGHTCTRLKEY, EVT_RIGHTSHIFTKEY, KM_ANY, KM_PRESS, KM_RELEASE, KMAP_MAX_NAME, wmKeyMap::modal_items, params, RIGHTMOUSE, STRNCPY, TWEAK_MODAL_CANCEL, TWEAK_MODAL_CONFIRM, TWEAK_MODAL_PRECISION_OFF, TWEAK_MODAL_PRECISION_ON, TWEAK_MODAL_SNAP_OFF, TWEAK_MODAL_SNAP_ON, WM_modalkeymap_add_item(), WM_modalkeymap_assign(), WM_modalkeymap_ensure(), and WM_modalkeymap_find().

Referenced by wm_gizmos_keymap().

◆ wm_gizmogrouptype_setup_keymap()

void wm_gizmogrouptype_setup_keymap ( wmGizmoGroupType * gzgt,
wmKeyConfig * keyconf )

Definition at line 1084 of file wm_gizmo_group.cc.

References wmGizmoGroupType::keyconf, wmGizmoGroupType::keymap, wmGizmoGroupType::setup_keymap, wmGizmoGroupType::type_update_flag, and WM_GIZMOMAPTYPE_KEYMAP_INIT.

Referenced by WM_gizmogroup_ensure_init(), WM_gizmomaptype_group_init_runtime_keymap(), and wm_gizmos_keymap().

◆ wm_gizmomap_deselect_all()

bool wm_gizmomap_deselect_all ( wmGizmoMap * gzmap)

Deselect all selected gizmos in gzmap.

Returns
if selection has changed.

Definition at line 875 of file wm_gizmo_map.cc.

References wmGizmoMap::gzmap_context, wmGizmoMapSelectState::items, wmGizmoMapSelectState::len, wmGizmoMap::select, wm_gizmo_select_set_ex(), and wm_gizmomap_select_array_clear().

Referenced by gizmo_select_invoke(), and WM_gizmomap_select_all().

◆ wm_gizmomap_select_array_clear()

void wm_gizmomap_select_array_clear ( wmGizmoMap * gzmap)

Definition at line 109 of file wm_gizmo_map.cc.

References wmGizmoMap::gzmap_context, wmGizmoMapSelectState::items, wmGizmoMapSelectState::len, wmGizmoMapSelectState::len_alloc, MEM_SAFE_FREE, and wmGizmoMap::select.

Referenced by wm_gizmomap_deselect_all(), wm_gizmomap_free_data(), and wm_gizmomap_select_array_shrink().

◆ wm_gizmomap_select_array_push_back()

void wm_gizmomap_select_array_push_back ( wmGizmoMap * gzmap,
wmGizmo * gz )

Definition at line 133 of file wm_gizmo_map.cc.

References BLI_assert, wmGizmoMap::gzmap_context, wmGizmoMapSelectState::items, wmGizmoMapSelectState::len, wmGizmoMapSelectState::len_alloc, MEM_reallocN, and wmGizmoMap::select.

Referenced by wm_gizmo_select_set_ex().

◆ wm_gizmomap_select_array_remove()

void wm_gizmomap_select_array_remove ( wmGizmoMap * gzmap,
wmGizmo * gz )

Definition at line 145 of file wm_gizmo_map.cc.

References wmGizmoMap::gzmap_context, wmGizmoMapSelectState::items, wmGizmoMapSelectState::len, wmGizmoMap::select, and wm_gizmomap_select_array_shrink().

Referenced by wm_gizmo_select_set_ex().

◆ wm_gizmomap_select_array_shrink()

void wm_gizmomap_select_array_shrink ( wmGizmoMap * gzmap,
int len_subtract )

Definition at line 117 of file wm_gizmo_map.cc.

References wmGizmoMap::gzmap_context, wmGizmoMapSelectState::items, wmGizmoMapSelectState::len, wmGizmoMapSelectState::len_alloc, MEM_reallocN, wmGizmoMap::select, and wm_gizmomap_select_array_clear().

Referenced by wm_gizmomap_select_array_remove().

Generated on Thu Feb 6 2025 07:36:39 for Blender by  doxygen 1.11.0