Blender V4.3
wm_gizmo_target_props.cc File Reference
Blender » GUI » Window Manager
#include "BLI_listbase.h"
#include "BKE_context.hh"
#include "MEM_guardedalloc.h"
#include "RNA_access.hh"
#include "WM_message.hh"
#include "WM_types.hh"
#include "ED_screen.hh"
#include "ANIM_keyframing.hh"

Go to the source code of this file.

Functions

Property Definition
BLI_INLINE wmGizmoProperty * wm_gizmo_target_property_array (wmGizmo *gz)
 
wmGizmoProperty * WM_gizmo_target_property_array (wmGizmo *gz)
 
wmGizmoProperty * WM_gizmo_target_property_at_index (wmGizmo *gz, int index)
 
wmGizmoProperty * WM_gizmo_target_property_find (wmGizmo *gz, const char *idname)
 
void WM_gizmo_target_property_def_rna_ptr (wmGizmo *gz, const wmGizmoPropertyType *gz_prop_type, PointerRNA *ptr, PropertyRNA *prop, int index)
 
void WM_gizmo_target_property_def_rna (wmGizmo *gz, const char *idname, PointerRNA *ptr, const char *propname, int index)
 
void WM_gizmo_target_property_def_func_ptr (wmGizmo *gz, const wmGizmoPropertyType *gz_prop_type, const wmGizmoPropertyFnParams *params)
 
void WM_gizmo_target_property_def_func (wmGizmo *gz, const char *idname, const wmGizmoPropertyFnParams *params)
 
void WM_gizmo_target_property_clear_rna_ptr (wmGizmo *gz, const wmGizmoPropertyType *gz_prop_type)
 
void WM_gizmo_target_property_clear_rna (wmGizmo *gz, const char *idname)
 
Property Access
bool WM_gizmo_target_property_is_valid_any (wmGizmo *gz)
 
bool WM_gizmo_target_property_is_valid (const wmGizmoProperty *gz_prop)
 
float WM_gizmo_target_property_float_get (const wmGizmo *gz, wmGizmoProperty *gz_prop)
 
void WM_gizmo_target_property_float_set (bContext *C, const wmGizmo *gz, wmGizmoProperty *gz_prop, const float value)
 
void WM_gizmo_target_property_float_get_array (const wmGizmo *gz, wmGizmoProperty *gz_prop, float *value)
 
void WM_gizmo_target_property_float_set_array (bContext *C, const wmGizmo *gz, wmGizmoProperty *gz_prop, const float *value)
 
bool WM_gizmo_target_property_float_range_get (const wmGizmo *gz, wmGizmoProperty *gz_prop, float range[2])
 
int WM_gizmo_target_property_array_length (const wmGizmo *, wmGizmoProperty *gz_prop)
 
Property Define
const wmGizmoPropertyType * WM_gizmotype_target_property_find (const wmGizmoType *gzt, const char *idname)
 
void WM_gizmotype_target_property_def (wmGizmoType *gzt, const char *idname, int data_type, int array_length)
 
Property Utilities
void WM_gizmo_do_msg_notify_tag_refresh (bContext *, wmMsgSubscribeKey *, wmMsgSubscribeValue *msg_val)
 
void WM_gizmo_target_property_subscribe_all (wmGizmo *gz, wmMsgBus *mbus, ARegion *region)
 
void WM_gizmo_target_property_anim_autokey (bContext *C, const wmGizmo *, wmGizmoProperty *gz_prop)
 

Function Documentation

◆ WM_gizmo_do_msg_notify_tag_refresh()

void WM_gizmo_do_msg_notify_tag_refresh ( bContext * C,
wmMsgSubscribeKey * msg_key,
wmMsgSubscribeValue * msg_val )

Definition at line 291 of file wm_gizmo_target_props.cc.

References ED_region_tag_redraw(), wmMsgSubscribeValue::owner, wmMsgSubscribeValue::user_data, and WM_gizmomap_tag_refresh().

Referenced by gizmo2d_pivot_point_message_subscribe(), gizmo_mesh_extrude_message_subscribe(), gizmo_mesh_spin_init_message_subscribe(), gizmo_xform_message_subscribe(), WIDGETGROUP_camera_message_subscribe(), WIDGETGROUP_gizmo_message_subscribe(), and WM_gizmo_target_property_subscribe_all().

◆ WM_gizmo_target_property_anim_autokey()

void WM_gizmo_target_property_anim_autokey ( bContext * C,
const wmGizmo * gz,
wmGizmoProperty * gz_prop )

Auto-key function if auto-key is enabled.

Definition at line 333 of file wm_gizmo_target_props.cc.

References blender::animrig::autokeyframe_property(), CTX_data_scene(), float, wmGizmoProperty::index, wmGizmoProperty::prop, and wmGizmoProperty::ptr.

Referenced by gizmo_arrow_exit(), gizmo_dial_exit(), and gizmo_move_exit().

◆ WM_gizmo_target_property_array()

wmGizmoProperty * WM_gizmo_target_property_array ( wmGizmo * gz)

Definition at line 35 of file wm_gizmo_target_props.cc.

References wm_gizmo_target_property_array().

Referenced by gizmo_update_prop_data(), ui_tooltip_data_from_gizmo(), WM_gizmo_free(), and WM_gizmo_target_property_subscribe_all().

◆ wm_gizmo_target_property_array()

BLI_INLINE wmGizmoProperty * wm_gizmo_target_property_array ( wmGizmo * gz)

Definition at line 30 of file wm_gizmo_target_props.cc.

References POINTER_OFFSET, wmGizmoType::struct_size, and wmGizmo::type.

Referenced by WM_gizmo_target_property_array(), WM_gizmo_target_property_at_index(), and WM_gizmo_target_property_is_valid_any().

◆ WM_gizmo_target_property_array_length()

int WM_gizmo_target_property_array_length ( const wmGizmo * gz,
wmGizmoProperty * gz_prop )

Definition at line 245 of file wm_gizmo_target_props.cc.

References wmGizmoPropertyType::array_length, wmGizmoProperty::custom_func, wmGizmoProperty::prop, wmGizmoProperty::ptr, RNA_property_array_length(), wmGizmoProperty::type, and wmGizmoProperty::value_get_fn.

Referenced by bpy_gizmo_target_get_value(), bpy_gizmo_target_set_value(), gizmo_cage2d_property_update(), and gizmo_cage3d_property_update().

◆ WM_gizmo_target_property_at_index()

wmGizmoProperty * WM_gizmo_target_property_at_index ( wmGizmo * gz,
int index )

Definition at line 40 of file wm_gizmo_target_props.cc.

References BLI_assert, and wm_gizmo_target_property_array().

Referenced by WM_gizmo_target_property_clear_rna_ptr(), WM_gizmo_target_property_def_func_ptr(), WM_gizmo_target_property_def_rna_ptr(), and WM_gizmo_target_property_find().

◆ WM_gizmo_target_property_clear_rna()

void WM_gizmo_target_property_clear_rna ( wmGizmo * gz,
const char * idname )

Definition at line 136 of file wm_gizmo_target_props.cc.

References wmGizmo::type, WM_gizmo_target_property_clear_rna_ptr(), and WM_gizmotype_target_property_find().

◆ WM_gizmo_target_property_clear_rna_ptr()

void WM_gizmo_target_property_clear_rna_ptr ( wmGizmo * gz,
const wmGizmoPropertyType * gz_prop_type )

Definition at line 122 of file wm_gizmo_target_props.cc.

References BLI_assert, wmGizmoProperty::index, wmGizmoPropertyType::index_in_type, blender::Vector< T, InlineBufferCapacity, Allocator >::is_empty(), wmGizmo::op_data, PointerRNA_NULL, wmGizmoProperty::prop, wmGizmoProperty::ptr, wmGizmoProperty::type, and WM_gizmo_target_property_at_index().

Referenced by WIDGETGROUP_camera_refresh(), and WM_gizmo_target_property_clear_rna().

◆ WM_gizmo_target_property_def_func()

void WM_gizmo_target_property_def_func ( wmGizmo * gz,
const char * idname,
const wmGizmoPropertyFnParams * params )

Definition at line 114 of file wm_gizmo_target_props.cc.

References params, wmGizmo::type, WM_gizmo_target_property_def_func_ptr(), and WM_gizmotype_target_property_find().

Referenced by gizmo_mesh_bisect_setup(), gizmo_mesh_placement_setup(), gizmo_mesh_spin_redo_setup(), blender::ed::view3d::geometry_nodes_gizmos::TransformGizmos::update_rotate_transform_and_target_property(), blender::ed::view3d::geometry_nodes_gizmos::TransformGizmos::update_scale_transform_and_target_property(), blender::ed::view3d::geometry_nodes_gizmos::DialGizmo::update_target_property(), blender::ed::view3d::geometry_nodes_gizmos::LinearGizmo::update_target_property(), blender::ed::view3d::geometry_nodes_gizmos::TransformGizmos::update_translate_transform_and_target_property(), WIDGETGROUP_armature_spline_refresh(), WIDGETGROUP_camera_view_refresh(), WIDGETGROUP_empty_image_refresh(), WIDGETGROUP_light_area_refresh(), WIDGETGROUP_light_point_setup(), WIDGETGROUP_light_spot_setup(), blender::ed::space_node::WIDGETGROUP_node_crop_refresh(), and blender::ed::space_node::WIDGETGROUP_node_transform_refresh().

◆ WM_gizmo_target_property_def_func_ptr()

void WM_gizmo_target_property_def_func_ptr ( wmGizmo * gz,
const wmGizmoPropertyType * gz_prop_type,
const wmGizmoPropertyFnParams * params )

Definition at line 92 of file wm_gizmo_target_props.cc.

References BLI_assert, wmGizmoProperty::custom_func, wmGizmoProperty::free_fn, wmGizmoPropertyType::index_in_type, blender::Vector< T, InlineBufferCapacity, Allocator >::is_empty(), wmGizmo::op_data, params, wmGizmoType::property_update, wmGizmoProperty::range_get_fn, wmGizmo::type, wmGizmoProperty::type, wmGizmoProperty::user_data, wmGizmoProperty::value_get_fn, wmGizmoProperty::value_set_fn, and WM_gizmo_target_property_at_index().

Referenced by bpy_gizmo_target_set_handler(), and WM_gizmo_target_property_def_func().

◆ WM_gizmo_target_property_def_rna()

void WM_gizmo_target_property_def_rna ( wmGizmo * gz,
const char * idname,
PointerRNA * ptr,
const char * propname,
int index )

Definition at line 81 of file wm_gizmo_target_props.cc.

References ptr, RNA_struct_find_property(), RNA_struct_identifier(), RNA_warning, PointerRNA::type, wmGizmo::type, WM_gizmo_target_property_def_rna_ptr(), and WM_gizmotype_target_property_find().

Referenced by WIDGETGROUP_camera_refresh(), WIDGETGROUP_forcefield_refresh(), WIDGETGROUP_light_spot_refresh(), blender::ed::space_node::WIDGETGROUP_node_corner_pin_refresh(), blender::ed::space_node::WIDGETGROUP_node_sbeam_refresh(), and blender::ed::space_node::WIDGETGROUP_node_transform_refresh().

◆ WM_gizmo_target_property_def_rna_ptr()

void WM_gizmo_target_property_def_rna_ptr ( wmGizmo * gz,
const wmGizmoPropertyType * gz_prop_type,
PointerRNA * ptr,
PropertyRNA * prop,
int index )

Definition at line 58 of file wm_gizmo_target_props.cc.

References BLI_assert, wmGizmoProperty::index, wmGizmoPropertyType::index_in_type, blender::Vector< T, InlineBufferCapacity, Allocator >::is_empty(), wmGizmo::op_data, wmGizmoProperty::prop, wmGizmoType::property_update, ptr, wmGizmoProperty::ptr, wmGizmo::type, wmGizmoProperty::type, and WM_gizmo_target_property_at_index().

Referenced by WIDGETGROUP_camera_refresh(), and WM_gizmo_target_property_def_rna().

◆ WM_gizmo_target_property_find()

wmGizmoProperty * WM_gizmo_target_property_find ( wmGizmo * gz,
const char * idname )

Definition at line 48 of file wm_gizmo_target_props.cc.

References BLI_findstringindex(), offsetof, wmGizmoType::target_property_defs, wmGizmo::type, and WM_gizmo_target_property_at_index().

Referenced by dial_draw_intern(), ED_gizmo_arrow3d_set_range_fac(), ED_gizmo_arrow3d_set_ui_range(), gizmo_arrow_exit(), gizmo_arrow_invoke(), gizmo_arrow_modal(), gizmo_cage2d_exit(), gizmo_cage2d_modal(), gizmo_cage3d_exit(), gizmo_cage3d_modal(), gizmo_dial_exit(), gizmo_dial_invoke(), gizmo_dial_modal(), gizmo_move_exit(), gizmo_move_invoke(), gizmo_move_modal(), and py_rna_gizmo_target_id_parse().

◆ WM_gizmo_target_property_float_get()

float WM_gizmo_target_property_float_get ( const wmGizmo * gz,
wmGizmoProperty * gz_prop )

Definition at line 166 of file wm_gizmo_target_props.cc.

References wmGizmoPropertyType::array_length, BLI_assert, wmGizmoProperty::custom_func, wmGizmoProperty::index, wmGizmoProperty::prop, wmGizmoProperty::ptr, RNA_property_float_get(), RNA_property_float_get_index(), wmGizmoProperty::type, and wmGizmoProperty::value_get_fn.

Referenced by bpy_gizmo_target_get_value(), dial_draw_intern(), gizmo_arrow_exit(), gizmo_arrow_invoke(), gizmo_arrow_modal(), gizmo_dial_invoke(), and gizmo_property_data_update().

◆ WM_gizmo_target_property_float_get_array()

void WM_gizmo_target_property_float_get_array ( const wmGizmo * gz,
wmGizmoProperty * gz_prop,
float * value )

Definition at line 202 of file wm_gizmo_target_props.cc.

References wmGizmoProperty::custom_func, wmGizmoProperty::prop, wmGizmoProperty::ptr, RNA_property_float_get_array(), and wmGizmoProperty::value_get_fn.

Referenced by bpy_gizmo_target_get_value(), gizmo_cage2d_modal(), gizmo_cage2d_property_update(), gizmo_cage3d_modal(), gizmo_cage3d_property_update(), gizmo_move_invoke(), and gizmo_move_property_update().

◆ WM_gizmo_target_property_float_range_get()

bool WM_gizmo_target_property_float_range_get ( const wmGizmo * gz,
wmGizmoProperty * gz_prop,
float range[2] )

Definition at line 227 of file wm_gizmo_target_props.cc.

References wmGizmoProperty::custom_func, wmGizmoProperty::prop, wmGizmoProperty::ptr, wmGizmoProperty::range_get_fn, RNA_property_float_ui_range(), and wmGizmoProperty::value_get_fn.

Referenced by bpy_gizmo_target_get_range(), and gizmo_property_data_update().

◆ WM_gizmo_target_property_float_set()

void WM_gizmo_target_property_float_set ( bContext * C,
const wmGizmo * gz,
wmGizmoProperty * gz_prop,
const float value )

Definition at line 181 of file wm_gizmo_target_props.cc.

References wmGizmoPropertyType::array_length, BLI_assert, wmGizmoProperty::custom_func, wmGizmoProperty::index, wmGizmoProperty::prop, wmGizmoProperty::ptr, RNA_property_float_set(), RNA_property_float_set_index(), RNA_property_update(), wmGizmoProperty::type, and wmGizmoProperty::value_set_fn.

Referenced by bpy_gizmo_target_set_value(), gizmo_arrow_modal(), gizmo_dial_exit(), gizmo_dial_modal(), and gizmo_property_value_reset().

◆ WM_gizmo_target_property_float_set_array()

void WM_gizmo_target_property_float_set_array ( bContext * C,
const wmGizmo * gz,
wmGizmoProperty * gz_prop,
const float * value )

Definition at line 213 of file wm_gizmo_target_props.cc.

References wmGizmoProperty::custom_func, wmGizmoProperty::prop, wmGizmoProperty::ptr, RNA_property_float_set_array(), RNA_property_update(), and wmGizmoProperty::value_set_fn.

Referenced by bpy_gizmo_target_set_value(), gizmo_cage2d_exit(), gizmo_cage2d_modal(), gizmo_cage3d_exit(), gizmo_cage3d_modal(), gizmo_move_exit(), and gizmo_move_modal().

◆ WM_gizmo_target_property_is_valid()

bool WM_gizmo_target_property_is_valid ( const wmGizmoProperty * gz_prop)

Definition at line 160 of file wm_gizmo_target_props.cc.

References wmGizmoProperty::custom_func, wmGizmoProperty::prop, wmGizmoProperty::value_get_fn, and wmGizmoProperty::value_set_fn.

Referenced by dial_draw_intern(), ED_gizmo_arrow3d_set_range_fac(), ED_gizmo_arrow3d_set_ui_range(), gizmo_arrow_exit(), gizmo_arrow_invoke(), gizmo_arrow_modal(), gizmo_dial_exit(), gizmo_dial_invoke(), gizmo_dial_modal(), gizmo_move_exit(), gizmo_move_invoke(), gizmo_move_modal(), gizmo_move_property_update(), gizmo_update_prop_data(), py_rna_gizmo_target_id_parse_and_ensure_is_valid(), WM_gizmo_target_property_is_valid_any(), and WM_gizmo_target_property_subscribe_all().

◆ WM_gizmo_target_property_is_valid_any()

bool WM_gizmo_target_property_is_valid_any ( wmGizmo * gz)

Definition at line 148 of file wm_gizmo_target_props.cc.

References wmGizmoType::target_property_defs_len, wmGizmo::type, wm_gizmo_target_property_array(), and WM_gizmo_target_property_is_valid().

◆ WM_gizmo_target_property_subscribe_all()

void WM_gizmo_target_property_subscribe_all ( wmGizmo * gz,
wmMsgBus * mbus,
ARegion * region )

Runs on the "prepare draw" pass, drawing the region clears.

Definition at line 305 of file wm_gizmo_target_props.cc.

References ED_region_do_msg_notify_tag_redraw(), wmMsgSubscribeValue::owner, wmGizmo::parent_gzgroup, wmGizmoGroup::parent_gzmap, wmGizmoProperty::prop, wmGizmoProperty::ptr, wmGizmoType::target_property_defs_len, wmGizmo::type, WM_gizmo_do_msg_notify_tag_refresh(), WM_gizmo_target_property_array(), WM_gizmo_target_property_is_valid(), and WM_msg_subscribe_rna().

Referenced by WM_gizmomap_message_subscribe().

◆ WM_gizmotype_target_property_def()

void WM_gizmotype_target_property_def ( wmGizmoType * gzt,
const char * idname,
int data_type,
int array_length )

Definition at line 266 of file wm_gizmo_target_props.cc.

References wmGizmoPropertyType::array_length, BLI_addtail(), BLI_assert, wmGizmoPropertyType::data_type, wmGizmoPropertyType::idname, wmGizmoPropertyType::index_in_type, MEM_callocN, wmGizmoType::target_property_defs, wmGizmoType::target_property_defs_len, and WM_gizmotype_target_property_find().

Referenced by bpy_gizmotype_target_property_def(), GIZMO_GT_arrow_3d(), GIZMO_GT_cage_2d(), GIZMO_GT_cage_3d(), GIZMO_GT_dial_3d(), and GIZMO_GT_move_3d().

◆ WM_gizmotype_target_property_find()

const wmGizmoPropertyType * WM_gizmotype_target_property_find ( const wmGizmoType * gzt,
const char * idname )

Definition at line 259 of file wm_gizmo_target_props.cc.

References BLI_findstring(), offsetof, and wmGizmoType::target_property_defs.

Referenced by py_rna_gizmo_target_type_id_parse(), WIDGETGROUP_camera_refresh(), WM_gizmo_target_property_clear_rna(), WM_gizmo_target_property_def_func(), WM_gizmo_target_property_def_rna(), and WM_gizmotype_target_property_def().

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