#include <WM_gizmo_types.hh>

Public Attributes
const char *	idname
const char *	name
char	owner_id [128]
wmGizmoGroupFnPoll	poll
wmGizmoGroupFnInit	setup
wmGizmoGroupFnRefresh	refresh
wmGizmoGroupFnDrawPrepare	draw_prepare
wmGizmoGroupFnInvokePrepare	invoke_prepare
wmGizmoGroupFnSetupKeymap	setup_keymap
wmGizmoGroupFnMsgBusSubscribe	message_subscribe
wmKeyMap *	keymap
wmKeyConfig *	keyconf
StructRNA *	srna
ExtensionRNA	rna_ext
eWM_GizmoFlagGroupTypeFlag	flag
eWM_GizmoFlagMapTypeUpdateFlag	type_update_flag
wmGizmoMapType_Params	gzmap_params
int	users

Detailed Description

Factory class for a gizmo-group type, gets called every time a new area is spawned.

Definition at line 421 of file WM_gizmo_types.hh.

Member Data Documentation

◆ draw_prepare

wmGizmoGroupFnDrawPrepare wmGizmoGroupType::draw_prepare

Refresh data for drawing, called before each redraw.

Definition at line 435 of file WM_gizmo_types.hh.

◆ flag

eWM_GizmoFlagGroupTypeFlag wmGizmoGroupType::flag

Definition at line 462 of file WM_gizmo_types.hh.

Referenced by button2d_draw_intern(), gizmo_button2d_bounds(), gizmo_cage2d_get_cursor(), gizmo_cage3d_get_cursor(), gizmo_draw_select_3d_loop(), gizmo_selectable_poll(), gizmo_window_project_2d(), gizmo_window_project_3d(), gizmos_draw_list(), IMAGE_GGT_gizmo2d(), IMAGE_GGT_gizmo2d_resize(), IMAGE_GGT_gizmo2d_rotate(), IMAGE_GGT_gizmo2d_translate(), MESH_GGT_add_bounds(), MESH_GGT_bisect(), MESH_GGT_spin(), MESH_GGT_spin_redo(), blender::ed::space_node::NODE_GGT_backdrop_box_mask(), blender::ed::space_node::NODE_GGT_backdrop_corner_pin(), blender::ed::space_node::NODE_GGT_backdrop_crop(), blender::ed::space_node::NODE_GGT_backdrop_ellipse_mask(), blender::ed::space_node::NODE_GGT_backdrop_glare(), blender::ed::space_node::NODE_GGT_backdrop_split(), blender::ed::space_node::NODE_GGT_backdrop_transform(), blender::ed::vse::SEQUENCER_GGT_gizmo2d(), blender::ed::vse::SEQUENCER_GGT_gizmo2d_resize(), blender::ed::vse::SEQUENCER_GGT_gizmo2d_rotate(), blender::ed::vse::SEQUENCER_GGT_gizmo2d_translate(), toolsystem_ref_link(), VIEW2D_GGT_navigate_impl(), VIEW3D_GGT_armature_spline(), VIEW3D_GGT_camera(), VIEW3D_GGT_camera_view(), VIEW3D_GGT_empty_image(), VIEW3D_GGT_force_field(), VIEW3D_GGT_geometry_nodes(), VIEW3D_GGT_light_area(), VIEW3D_GGT_light_point(), VIEW3D_GGT_light_spot(), VIEW3D_GGT_light_target(), VIEW3D_GGT_mesh_preselect_edgering(), VIEW3D_GGT_mesh_preselect_elem(), VIEW3D_GGT_navigate(), VIEW3D_GGT_placement(), VIEW3D_GGT_ruler(), VIEW3D_GGT_tool_generic_handle_free(), VIEW3D_GGT_tool_generic_handle_normal(), blender::ed::transform::VIEW3D_GGT_xform_cage(), blender::ed::transform::VIEW3D_GGT_xform_extrude(), blender::ed::transform::VIEW3D_GGT_xform_gizmo(), blender::ed::transform::VIEW3D_GGT_xform_gizmo_context(), blender::ed::transform::VIEW3D_GGT_xform_shear(), wm_event_get_keymap_from_toolsystem_ex(), wm_gizmo_calculate_scale(), WM_gizmo_group_refresh(), wm_gizmogroup_intersectable_gizmos_to_list(), wm_gizmogroup_is_any_selected(), wm_gizmogroup_is_visible_in_drawstep(), wm_gizmogrouptype_append__end(), WM_gizmomap_drawstep_from_gizmo_group(), WM_gizmomap_tooltip_init(), WM_gizmomaptype_group_init_runtime(), wm_handler_operator_call(), and WM_toolsystem_ref_set_from_runtime().

◆ gzmap_params

wmGizmoMapType_Params wmGizmoGroupType::gzmap_params

Same as gizmo-maps, so registering/unregistering goes to the correct region.

Definition at line 468 of file WM_gizmo_types.hh.

Referenced by ED_gizmo_poll_or_unlink_delayed_from_tool_ex(), IMAGE_GGT_gizmo2d(), IMAGE_GGT_gizmo2d_resize(), IMAGE_GGT_gizmo2d_rotate(), IMAGE_GGT_gizmo2d_translate(), MESH_GGT_add_bounds(), MESH_GGT_bisect(), MESH_GGT_spin(), MESH_GGT_spin_redo(), blender::ed::vse::SEQUENCER_GGT_gizmo2d(), blender::ed::vse::SEQUENCER_GGT_gizmo2d_resize(), blender::ed::vse::SEQUENCER_GGT_gizmo2d_rotate(), blender::ed::vse::SEQUENCER_GGT_gizmo2d_translate(), toolsystem_ref_link(), VIEW3D_GGT_mesh_preselect_edgering(), VIEW3D_GGT_mesh_preselect_elem(), VIEW3D_GGT_placement(), VIEW3D_GGT_ruler(), VIEW3D_GGT_tool_generic_handle_free(), VIEW3D_GGT_tool_generic_handle_normal(), blender::ed::transform::VIEW3D_GGT_xform_cage(), blender::ed::transform::VIEW3D_GGT_xform_extrude(), blender::ed::transform::VIEW3D_GGT_xform_gizmo(), blender::ed::transform::VIEW3D_GGT_xform_shear(), WIDGETGROUP_navigate_setup(), WM_gizmo_group_remove_by_tool(), WM_gizmo_group_type_add_ptr(), WM_gizmo_group_type_ensure_ptr(), WM_gizmo_group_type_reinit_ptr(), WM_gizmo_group_type_remove_ptr(), WM_gizmo_group_type_unlink_delayed_ptr(), WM_gizmogrouptype_append_and_link(), and wm_handler_operator_call().

◆ idname

const char* wmGizmoGroupType::idname

Definition at line 422 of file WM_gizmo_types.hh.

Referenced by ED_gizmo_poll_or_unlink_delayed_from_tool(), get_gizmo_group_type_map(), gizmo_window_project_2d(), gizmo_window_project_3d(), gizmogroup_properties_init(), gizmogrouptype_free(), IMAGE_GGT_gizmo2d(), IMAGE_GGT_gizmo2d_resize(), IMAGE_GGT_gizmo2d_rotate(), IMAGE_GGT_gizmo2d_translate(), MESH_GGT_add_bounds(), MESH_GGT_bisect(), MESH_GGT_spin(), MESH_GGT_spin_redo(), blender::ed::space_node::NODE_GGT_backdrop_box_mask(), blender::ed::space_node::NODE_GGT_backdrop_corner_pin(), blender::ed::space_node::NODE_GGT_backdrop_crop(), blender::ed::space_node::NODE_GGT_backdrop_ellipse_mask(), blender::ed::space_node::NODE_GGT_backdrop_glare(), blender::ed::space_node::NODE_GGT_backdrop_split(), blender::ed::space_node::NODE_GGT_backdrop_transform(), blender::ed::vse::SEQUENCER_GGT_gizmo2d(), blender::ed::vse::SEQUENCER_GGT_gizmo2d_resize(), blender::ed::vse::SEQUENCER_GGT_gizmo2d_rotate(), blender::ed::vse::SEQUENCER_GGT_gizmo2d_translate(), tool_generic_create_gizmo(), VIEW2D_GGT_navigate_impl(), VIEW3D_GGT_armature_spline(), VIEW3D_GGT_camera(), VIEW3D_GGT_camera_view(), VIEW3D_GGT_empty_image(), VIEW3D_GGT_force_field(), VIEW3D_GGT_geometry_nodes(), VIEW3D_GGT_light_area(), VIEW3D_GGT_light_point(), VIEW3D_GGT_light_spot(), VIEW3D_GGT_light_target(), VIEW3D_GGT_mesh_preselect_edgering(), VIEW3D_GGT_mesh_preselect_elem(), VIEW3D_GGT_navigate(), VIEW3D_GGT_placement(), VIEW3D_GGT_ruler(), VIEW3D_GGT_tool_generic_handle_free(), VIEW3D_GGT_tool_generic_handle_normal(), blender::ed::transform::VIEW3D_GGT_xform_cage(), blender::ed::transform::VIEW3D_GGT_xform_extrude(), blender::ed::transform::VIEW3D_GGT_xform_gizmo(), blender::ed::transform::VIEW3D_GGT_xform_gizmo_context(), blender::ed::transform::VIEW3D_GGT_xform_shear(), WIDGETGROUP_tool_generic_refresh(), WM_gizmo_group_type_free_ptr(), and wm_gizmogrouptype_append__end().

◆ invoke_prepare

wmGizmoGroupFnInvokePrepare wmGizmoGroupType::invoke_prepare

Initialize data for before invoke.

Definition at line 437 of file WM_gizmo_types.hh.

Referenced by blender::ed::transform::ED_widgetgroup_gizmo2d_resize_callbacks_set(), blender::ed::transform::ED_widgetgroup_gizmo2d_xform_callbacks_set(), gizmo_tweak_start_and_finish(), MESH_GGT_spin(), blender::ed::transform::VIEW3D_GGT_xform_extrude(), blender::ed::transform::VIEW3D_GGT_xform_gizmo(), blender::ed::transform::VIEW3D_GGT_xform_gizmo_context(), and wm_gizmomap_modal_set().

◆ keyconf

wmKeyConfig* wmGizmoGroupType::keyconf

Only for convenient removal.

Definition at line 451 of file WM_gizmo_types.hh.

Referenced by wm_gizmogrouptype_setup_keymap(), and WM_gizmomaptype_group_unlink().

◆ keymap

wmKeyMap* wmGizmoGroupType::keymap

Keymap created with callback from above.

Definition at line 449 of file WM_gizmo_types.hh.

Referenced by wm_gizmo_keymap_uses_event_modifier(), WM_gizmogroup_ensure_init(), wm_gizmogrouptype_setup_keymap(), WM_gizmomaptype_group_unlink(), and wm_handlers_do_gizmo_handler().

◆ message_subscribe

wmGizmoGroupFnMsgBusSubscribe wmGizmoGroupType::message_subscribe

Optionally subscribe to wmMsgBus events, these are calculated automatically from RNA properties, only needed if gizmos depend indirectly on properties.

Definition at line 446 of file WM_gizmo_types.hh.

◆ name

const char* wmGizmoGroupType::name

Gizmo-group name - displayed in UI (keymap editor).

Definition at line 424 of file WM_gizmo_types.hh.

Referenced by gizmo_tweak_finish(), IMAGE_GGT_gizmo2d(), IMAGE_GGT_gizmo2d_resize(), IMAGE_GGT_gizmo2d_rotate(), IMAGE_GGT_gizmo2d_translate(), MESH_GGT_add_bounds(), MESH_GGT_bisect(), MESH_GGT_spin(), MESH_GGT_spin_redo(), blender::ed::space_node::NODE_GGT_backdrop_box_mask(), blender::ed::space_node::NODE_GGT_backdrop_corner_pin(), blender::ed::space_node::NODE_GGT_backdrop_crop(), blender::ed::space_node::NODE_GGT_backdrop_ellipse_mask(), blender::ed::space_node::NODE_GGT_backdrop_glare(), blender::ed::space_node::NODE_GGT_backdrop_split(), blender::ed::space_node::NODE_GGT_backdrop_transform(), blender::ed::vse::SEQUENCER_GGT_gizmo2d(), blender::ed::vse::SEQUENCER_GGT_gizmo2d_resize(), blender::ed::vse::SEQUENCER_GGT_gizmo2d_rotate(), blender::ed::vse::SEQUENCER_GGT_gizmo2d_translate(), VIEW2D_GGT_navigate_impl(), VIEW3D_GGT_armature_spline(), VIEW3D_GGT_camera(), VIEW3D_GGT_camera_view(), VIEW3D_GGT_empty_image(), VIEW3D_GGT_force_field(), VIEW3D_GGT_geometry_nodes(), VIEW3D_GGT_light_area(), VIEW3D_GGT_light_point(), VIEW3D_GGT_light_spot(), VIEW3D_GGT_light_target(), VIEW3D_GGT_mesh_preselect_edgering(), VIEW3D_GGT_mesh_preselect_elem(), VIEW3D_GGT_navigate(), VIEW3D_GGT_placement(), VIEW3D_GGT_ruler(), VIEW3D_GGT_tool_generic_handle_free(), VIEW3D_GGT_tool_generic_handle_normal(), blender::ed::transform::VIEW3D_GGT_xform_cage(), blender::ed::transform::VIEW3D_GGT_xform_extrude(), blender::ed::transform::VIEW3D_GGT_xform_gizmo(), blender::ed::transform::VIEW3D_GGT_xform_gizmo_context(), blender::ed::transform::VIEW3D_GGT_xform_shear(), and wm_gizmogrouptype_append__end().

◆ owner_id

char wmGizmoGroupType::owner_id[128]

Optional, see: wmOwnerID.

Definition at line 426 of file WM_gizmo_types.hh.

Referenced by WM_gizmo_group_type_poll().

◆ poll

wmGizmoGroupFnPoll wmGizmoGroupType::poll

Poll if gizmo-map should be visible.

Definition at line 429 of file WM_gizmo_types.hh.

◆ refresh

wmGizmoGroupFnRefresh wmGizmoGroupType::refresh

Refresh data, only called if recreate flag is set (WM_gizmomap_tag_refresh).

Definition at line 433 of file WM_gizmo_types.hh.

◆ rna_ext

ExtensionRNA wmGizmoGroupType::rna_ext

RNA integration.

Definition at line 460 of file WM_gizmo_types.hh.

Referenced by BPY_RNA_gizmogroup_wrapper(), gizmogroup_properties_init(), and gizmogrouptype_free().

◆ setup

wmGizmoGroupFnInit wmGizmoGroupType::setup

Initially create gizmos and set permanent data - stuff you only need to do once.

Definition at line 431 of file WM_gizmo_types.hh.

◆ setup_keymap

wmGizmoGroupFnSetupKeymap wmGizmoGroupType::setup_keymap

Keymap init callback for this gizmo-group (optional), will fall back to default tweak keymap when left NULL.

Definition at line 441 of file WM_gizmo_types.hh.

◆ srna

StructRNA* wmGizmoGroupType::srna

RNA for properties.

Definition at line 457 of file WM_gizmo_types.hh.

Referenced by BPY_RNA_gizmogroup_wrapper(), blender::ed::transform::gizmo_mesh_extrude_message_subscribe(), blender::ed::transform::gizmo_mesh_extrude_setup(), gizmo_mesh_spin_init_message_subscribe(), gizmo_mesh_spin_init_setup(), gizmogroup_properties_init(), MESH_GGT_spin(), VIEW3D_GGT_tool_generic_handle_free(), VIEW3D_GGT_tool_generic_handle_normal(), blender::ed::transform::VIEW3D_GGT_xform_extrude(), blender::ed::transform::VIEW3D_GGT_xform_gizmo(), wm_gizmogrouptype_append__begin(), and wm_gizmogrouptype_append__end().

◆ type_update_flag

eWM_GizmoFlagMapTypeUpdateFlag wmGizmoGroupType::type_update_flag

So we know which group type to update.

Definition at line 465 of file WM_gizmo_types.hh.

Referenced by WM_gizmoconfig_update_tag_group_type_init(), WM_gizmoconfig_update_tag_group_type_remove(), wm_gizmogrouptype_append__end(), and wm_gizmogrouptype_setup_keymap().

◆ users

int wmGizmoGroupType::users

Number of wmGizmoGroup instances. Decremented when 'tag_remove' is set, or when removed.

Definition at line 474 of file WM_gizmo_types.hh.

Referenced by ED_gizmo_poll_or_unlink_delayed_from_tool_ex(), WM_gizmo_group_tag_remove(), wm_gizmogroup_free(), and wm_gizmogroup_new_from_type().

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

WM_gizmo_types.hh

Public Attributes