BKE_idprop.hh File Reference

#include <memory>
#include "DNA_ID_enums.h"
#include "BLI_compiler_attrs.h"
#include "BLI_function_ref.hh"
#include "BLI_span.hh"
#include "BLI_string_ref.hh"
#include "BLI_sys_types.h"

Go to the source code of this file.

Classes
union	IDPropertyTemplate
class	blender::bke::idprop::IDPropertyDeleter

Namespaces
namespace	blender
namespace	blender::io
namespace	blender::io::serialize
namespace	blender::bke
namespace	blender::bke::idprop

Macros
#define	IDP_Int(prop)
#define	IDP_Bool(prop)
#define	IDP_Array(prop)
#define	IDP_Float(prop)
#define	IDP_Double(prop)
#define	IDP_String(prop)
#define	IDP_IDPArray(prop)
#define	IDP_Id(prop)
#define	IDP_BlendDataRead(reader, prop)

Typedefs
using	IDPWalkFunc = void (*)(void *user_data, IDProperty *idp)

Enumerations
enum	eIDPropertyUIDataType {   IDP_UI_DATA_TYPE_UNSUPPORTED = -1 , IDP_UI_DATA_TYPE_INT = 0 , IDP_UI_DATA_TYPE_FLOAT = 1 , IDP_UI_DATA_TYPE_STRING = 2 ,   IDP_UI_DATA_TYPE_ID = 3 , IDP_UI_DATA_TYPE_BOOLEAN = 4 }

Functions
IDProperty *	IDP_NewIDPArray (blender::StringRef name) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
IDProperty *	IDP_CopyIDPArray (const IDProperty *array, int flag) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
void	IDP_SetIndexArray (IDProperty *prop, int index, IDProperty *item) ATTR_NONNULL()
IDProperty *	IDP_GetIndexArray (IDProperty *prop, int index) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
void	IDP_AppendArray (IDProperty *prop, IDProperty *item)
void	IDP_ResizeIDPArray (IDProperty *prop, int newlen)
void	IDP_ResizeArray (IDProperty *prop, int newlen)
void	IDP_FreeArray (IDProperty *prop)
IDProperty *	IDP_NewStringMaxSize (const char *st, size_t st_maxncpy, blender::StringRef name, eIDPropertyFlag flags={}) ATTR_WARN_UNUSED_RESULT
IDProperty *	IDP_NewString (const char *st, blender::StringRef name, eIDPropertyFlag flags={}) ATTR_WARN_UNUSED_RESULT
void	IDP_AssignStringMaxSize (IDProperty *prop, const char *st, size_t st_maxncpy) ATTR_NONNULL()
void	IDP_AssignString (IDProperty *prop, const char *st) ATTR_NONNULL()
void	IDP_FreeString (IDProperty *prop) ATTR_NONNULL()
const IDPropertyUIDataEnumItem *	IDP_EnumItemFind (const IDProperty *prop)
bool	IDP_EnumItemsValidate (const IDPropertyUIDataEnumItem *items, int items_num, void(*error_fn)(const char *))
void	IDP_AssignID (IDProperty *prop, ID *id, int flag)
void	IDP_SyncGroupValues (IDProperty *dest, const IDProperty *src) ATTR_NONNULL()
void	IDP_SyncGroupTypes (IDProperty *dest, const IDProperty *src, bool do_arraylen) ATTR_NONNULL()
void	IDP_ReplaceGroupInGroup (IDProperty *dest, const IDProperty *src) ATTR_NONNULL()
void	IDP_ReplaceInGroup (IDProperty *group, IDProperty *prop) ATTR_NONNULL()
void	IDP_ReplaceInGroup_ex (IDProperty *group, IDProperty *prop, IDProperty *prop_exist, int flag)
void	IDP_MergeGroup (IDProperty *dest, const IDProperty *src, bool do_overwrite) ATTR_NONNULL()
void	IDP_MergeGroup_ex (IDProperty *dest, const IDProperty *src, bool do_overwrite, int flag) ATTR_NONNULL()
bool	IDP_AddToGroup (IDProperty *group, IDProperty *prop) ATTR_NONNULL()
bool	IDP_InsertToGroup (IDProperty *group, IDProperty *previous, IDProperty *pnew) ATTR_NONNULL(1
bool void	IDP_RemoveFromGroup (IDProperty *group, IDProperty *prop) ATTR_NONNULL()
void	IDP_FreeFromGroup (IDProperty *group, IDProperty *prop) ATTR_NONNULL()
IDProperty *	IDP_GetPropertyFromGroup (const IDProperty *prop, blender::StringRef name) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
IDProperty *	IDP_GetPropertyFromGroup (const IDProperty *prop, const char *name) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
IDProperty *	IDP_GetPropertyTypeFromGroup (const IDProperty *prop, blender::StringRef name, char type) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
IDProperty *	IDP_GetProperties (ID *id) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
IDProperty *	IDP_EnsureProperties (ID *id) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1)
IDProperty *	IDP_CopyProperty (const IDProperty *prop) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
IDProperty *	IDP_CopyProperty_ex (const IDProperty *prop, int flag) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
void	IDP_CopyPropertyContent (IDProperty *dst, const IDProperty *src) ATTR_NONNULL()
bool	IDP_EqualsProperties_ex (const IDProperty *prop1, const IDProperty *prop2, bool is_strict) ATTR_WARN_UNUSED_RESULT
bool	IDP_EqualsProperties (const IDProperty *prop1, const IDProperty *prop2) ATTR_WARN_UNUSED_RESULT
IDProperty *	IDP_New (char type, const IDPropertyTemplate *val, blender::StringRef name, eIDPropertyFlag flags={}) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
void	IDP_FreePropertyContent_ex (IDProperty *prop, bool do_id_user)
void	IDP_FreePropertyContent (IDProperty *prop)
void	IDP_FreeProperty_ex (IDProperty *prop, bool do_id_user)
void	IDP_FreeProperty (IDProperty *prop)
void	IDP_ClearProperty (IDProperty *prop)
void	IDP_Reset (IDProperty *prop, const IDProperty *reference)
int	IDP_coerce_to_int_or_zero (const IDProperty *prop)
float	IDP_coerce_to_float_or_zero (const IDProperty *prop)
double	IDP_coerce_to_double_or_zero (const IDProperty *prop)
void	IDP_foreach_property (IDProperty *id_property_root, int type_filter, blender::FunctionRef< void(IDProperty *id_property)> callback)
char *	IDP_reprN (const IDProperty *prop, uint *r_len)
void	IDP_repr_fn (const IDProperty *prop, void(*str_append_fn)(void *user_data, const char *str, uint str_len), void *user_data)
void	IDP_print (const IDProperty *prop)
const char *	IDP_type_str (eIDPropertyType type, short sub_type)
const char *	IDP_type_str (const IDProperty *prop)
void	IDP_BlendWrite (BlendWriter *writer, const IDProperty *prop)
void	IDP_BlendReadData_impl (BlendDataReader *reader, IDProperty **prop, const char *caller_func_id)
bool	IDP_ui_data_supported (const IDProperty *prop)
eIDPropertyUIDataType	IDP_ui_data_type (const IDProperty *prop)
void	IDP_ui_data_free (IDProperty *prop)
void	IDP_ui_data_free_unique_contents (IDPropertyUIData *ui_data, eIDPropertyUIDataType type, const IDPropertyUIData *other)
IDPropertyUIData *	IDP_ui_data_ensure (IDProperty *prop)
IDPropertyUIData *	IDP_ui_data_copy (const IDProperty *prop)
IDPropertyUIData *	IDP_TryConvertUIData (IDPropertyUIData *src, eIDPropertyUIDataType src_type, eIDPropertyUIDataType dst_type)
IDProperty to Value
std::unique_ptr< blender::io::serialize::ArrayValue >	blender::bke::idprop::convert_to_serialize_values (const IDProperty *properties)
	Convert the given properties to Value objects for serialization.
IDProperty from Value
IDProperty *	blender::bke::idprop::convert_from_serialize_value (const blender::io::serialize::Value &value)
	Convert the given value to an IDProperty.
Create Functions
std::unique_ptr< IDProperty, IDPropertyDeleter >	blender::bke::idprop::create_bool (StringRef prop_name, bool value, eIDPropertyFlag flags={})
	Allocate a new IDProperty of type IDP_BOOLEAN, set its name and value.
std::unique_ptr< IDProperty, IDPropertyDeleter >	blender::bke::idprop::create (StringRef prop_name, int32_t value, eIDPropertyFlag flags={})
	Allocate a new IDProperty of type IDP_INT, set its name and value.
std::unique_ptr< IDProperty, IDPropertyDeleter >	blender::bke::idprop::create (StringRef prop_name, float value, eIDPropertyFlag flags={})
	Allocate a new IDProperty of type IDP_FLOAT, set its name and value.
std::unique_ptr< IDProperty, IDPropertyDeleter >	blender::bke::idprop::create (StringRef prop_name, double value, eIDPropertyFlag flags={})
	Allocate a new IDProperty of type IDP_DOUBLE, set its name and value.
std::unique_ptr< IDProperty, IDPropertyDeleter >	blender::bke::idprop::create (StringRef prop_name, StringRefNull value, eIDPropertyFlag flags={})
	Allocate a new IDProperty of type IDP_STRING, set its name and value.
std::unique_ptr< IDProperty, IDPropertyDeleter >	blender::bke::idprop::create (StringRef prop_name, ID *value, eIDPropertyFlag flags={})
	Allocate a new IDProperty of type IDP_ID, set its name and value.
std::unique_ptr< IDProperty, IDPropertyDeleter >	blender::bke::idprop::create (StringRef prop_name, Span< int32_t > values, eIDPropertyFlag flags={})
	Allocate a new IDProperty of type IDP_ARRAY and sub-type IDP_INT.
std::unique_ptr< IDProperty, IDPropertyDeleter >	blender::bke::idprop::create (StringRef prop_name, Span< float > values, eIDPropertyFlag flags={})
	Allocate a new IDProperty of type IDP_ARRAY and sub-type IDP_FLOAT.
std::unique_ptr< IDProperty, IDPropertyDeleter >	blender::bke::idprop::create (StringRef prop_name, Span< double > values, eIDPropertyFlag flags={})
	Allocate a new IDProperty of type IDP_ARRAY and sub-type IDP_DOUBLE.
std::unique_ptr< IDProperty, IDPropertyDeleter >	blender::bke::idprop::create_group (StringRef prop_name, eIDPropertyFlag flags={})
	Allocate a new IDProperty of type IDP_GROUP.

Macro Definition Documentation

IDP_Array

#define IDP_Array

(

prop

)

Value:

((prop)->data.pointer)

Definition at line 287 of file BKE_idprop.hh.

Referenced by blender::bke::idprop::array_values_set(), bc_get_property_matrix(), BPy_IDArray_ass_slice(), BPy_IDArray_getbuffer(), BPy_IDArray_GetItem(), BPy_IDArray_SetItem(), BPy_IDArray_slice(), BPy_IDGroup_MapDataToPy(), IDP_EqualsProperties_ex(), IDP_foreach_property(), idp_from_PySequence_Buffer(), idp_from_PySequence_Fast(), idprop_py_from_idp_string(), blender::bke::idprop::IDPArraySerializer::idprop_to_dictionary(), blender::nodes::init_socket_cpp_value_from_property(), blender::nodes::old_id_property_type_matches_socket_convert_to_new_float_vec(), proj_paint_state_viewport_init(), RNA_property_boolean_get_array(), RNA_property_boolean_set_array(), RNA_property_float_get_array(), RNA_property_float_set_array(), RNA_property_int_get_array(), RNA_property_int_set_array(), blender::bke::idprop::tests::test_idprop(), blender::bke::idprop::tests::test_idprop(), blender::bke::idprop::tests::test_idprop(), version_idproperty_move_data_float(), version_idproperty_move_data_int(), and view3d_ob_drop_on_enter().

IDP_BlendDataRead

#define IDP_BlendDataRead	(		reader,
			prop )

Value:

IDP_BlendReadData_impl(reader, prop, __func__)

Definition at line 360 of file BKE_idprop.hh.

Referenced by BKE_asset_metadata_read(), BKE_collection_blend_read_data(), BKE_pose_blend_read_data(), BKE_screen_view3d_shading_blend_read_data(), BKE_time_markers_blend_read(), BKE_view_layer_blend_read_data(), blender::blend_read(), direct_link_bone_collection(), direct_link_bones(), direct_link_id_common(), direct_link_keymapitem(), blender::bke::direct_link_node_socket(), direct_link_region(), blender::bke::node_interface::item_types::item_read_data(), blender::bke::node_tree_blend_read_data(), read_userdef(), scene_blend_read_data(), blender::seq::strip_read_data_cb(), and workspace_blend_read_data().

IDP_Bool

#define IDP_Bool

(

prop

)

Value:

((prop)->data.val)

Definition at line 286 of file BKE_idprop.hh.

Referenced by bc_get_property(), blender::ed::object::geometry_nodes_input_attribute_toggle_exec(), IDP_coerce_to_double_or_zero(), IDP_coerce_to_float_or_zero(), IDP_coerce_to_int_or_zero(), IDP_EqualsProperties_ex(), idp_from_PyBool(), idp_repr_fn_recursive(), idprop_py_from_idp_bool(), blender::bke::idprop::IDPBoolSerializer::idprop_to_dictionary(), blender::nodes::init_socket_cpp_value_from_property(), blender::nodes::input_attribute_name_get(), blender::nodes::old_id_property_type_matches_socket_convert_to_new(), RNA_property_boolean_get(), and RNA_property_boolean_set().

IDP_Double

#define IDP_Double

(

prop

)

Value:

(*(double *)&(prop)->data.val)

Definition at line 312 of file BKE_idprop.hh.

Referenced by bc_get_property(), IDP_coerce_to_double_or_zero(), IDP_coerce_to_float_or_zero(), IDP_coerce_to_int_or_zero(), IDP_EqualsProperties_ex(), idp_from_PyFloat(), idp_from_PyLong(), idp_repr_fn_recursive(), idprop_py_from_idp_double(), blender::bke::idprop::IDPDoubleSerializer::idprop_to_dictionary(), blender::nodes::init_socket_cpp_value_from_property(), blender::nodes::old_id_property_type_matches_socket_convert_to_new(), RNA_property_float_get(), RNA_property_float_set(), RNA_property_float_set_array(), blender::ed::object::shade_auto_smooth_exec(), and blender::bke::idprop::tests::test_idprop().

IDP_Float

#define IDP_Float

(

prop

)

Value:

(*(float *)&(prop)->data.val)

Definition at line 311 of file BKE_idprop.hh.

Referenced by bc_get_property(), camera_write_cycles_compatibility_data_create(), IDP_coerce_to_double_or_zero(), IDP_coerce_to_float_or_zero(), IDP_coerce_to_int_or_zero(), IDP_EqualsProperties_ex(), idp_from_PyFloat(), idp_from_PyLong(), idp_repr_fn_recursive(), idprop_py_from_idp_float(), blender::bke::idprop::IDPFloatSerializer::idprop_to_dictionary(), blender::nodes::init_socket_cpp_value_from_property(), blender::nodes::old_id_property_type_matches_socket_convert_to_new(), RNA_property_float_get(), RNA_property_float_set(), RNA_property_float_set_array(), blender::ed::object::shade_auto_smooth_exec(), blender::bke::idprop::tests::test_idprop(), and version_cycles_property_float().

IDP_Id

#define IDP_Id

(

prop

)

Value:

((ID *)(prop)->data.pointer)

Definition at line 315 of file BKE_idprop.hh.

Referenced by IDP_AssignID(), IDP_CopyID(), IDP_EqualsProperties_ex(), IDP_FreePropertyContent_ex(), IDP_New(), idprop_ui_data_to_dict_id(), blender::nodes::init_socket_cpp_value_from_property(), blender::nodes::old_id_property_type_matches_socket_convert_to_new(), blender::ed::geometry::replace_inputs_evaluated_data_blocks(), and RNA_property_pointer_get().

IDP_IDPArray

#define IDP_IDPArray

(

prop

)

Value:

((IDProperty *)(prop)->data.pointer)

Definition at line 314 of file BKE_idprop.hh.

Referenced by BPy_IDGroup_MapDataToPy(), IDP_EqualsProperties_ex(), idprop_py_from_idp_idparray(), rna_idp_path(), RNA_property_collection_begin(), RNA_property_collection_clear(), RNA_property_collection_move(), and RNA_property_collection_remove().

IDP_Int

#define IDP_Int

(

prop

)

Value:

((prop)->data.val)

Definition at line 285 of file BKE_idprop.hh.

Referenced by bc_get_property(), BKE_keyconfig_pref_set_select_mouse(), blender::ed::geometry::build_catalog_tree(), blender::ed::object::build_catalog_tree(), blender::ed::space_node::build_catalog_tree(), camera_write_cycles_compatibility_data_create(), blender::ed::object::geometry_nodes_input_attribute_toggle_exec(), IDP_coerce_to_double_or_zero(), IDP_coerce_to_float_or_zero(), IDP_coerce_to_int_or_zero(), IDP_DirectLinkProperty(), IDP_EnumItemFind(), IDP_EqualsProperties_ex(), idp_from_PyBool(), idp_from_PyLong(), idp_repr_fn_recursive(), idprop_py_from_idp_int(), blender::bke::idprop::IDPIntSerializer::idprop_to_dictionary(), blender::nodes::init_socket_cpp_value_from_property(), blender::nodes::input_attribute_name_get(), keymap_update_brushes_handle_add_item(), keymap_update_brushes_handle_remove_item(), blender::ed::space_node::node_group_drop_poll(), blender::nodes::old_id_property_type_matches_socket_convert_to_new(), blender::nodes::old_id_property_type_matches_socket_convert_to_new_int(), RNA_property_boolean_set_array(), RNA_property_enum_get(), RNA_property_enum_set(), RNA_property_int_get(), RNA_property_int_set(), RNA_property_int_set_array(), blender::ed::geometry::run_node_group_depends_on_cursor(), blender::ed::space_node::search_link_ops_for_asset_metadata(), blender::bke::idprop::tests::test_idprop(), blender::nodes::update_input_properties_from_node_tree(), version_cycles_property_int(), version_cycles_property_int_set(), and view3d_geometry_nodes_drop_poll().

IDP_String

#define IDP_String

(

prop

)

Value:

((char *)(prop)->data.pointer)

Definition at line 313 of file BKE_idprop.hh.

Referenced by blender::nodes::find_output_attributes_to_store(), blender::ed::geometry::gather_input_ids(), IDP_AssignStringMaxSize(), IDP_EqualsProperties_ex(), IDP_New(), IDP_NewStringMaxSize(), idp_repr_fn_recursive(), idprop_py_from_idp_string(), blender::bke::idprop::IDPStringSerializer::idprop_to_dictionary(), blender::imbuf::imb_create_write_spec(), IMB_metadata_foreach(), IMB_metadata_get_field(), blender::nodes::init_socket_cpp_value_from_property(), blender::nodes::initialize_group_input(), blender::nodes::input_attribute_name_get(), keymap_update_brushes_handle_add_item(), blender::nodes::old_id_property_type_matches_socket_convert_to_new_string(), openexr_header_metadata(), RNA_property_string_get(), RNA_property_string_get(), RNA_property_string_length(), blender::ed::space_node::search_link_ops_for_asset_metadata(), blender::bke::idprop::tests::test_idprop(), version_bonelayers_to_bonecollections(), version_idproperty_move_data_string(), version_idproperty_ui_data(), version_mesh_crease_generic(), and write_jpeg().

Typedef Documentation

IDPWalkFunc

using IDPWalkFunc = void (*)(void *user_data, IDProperty *idp)

Definition at line 117 of file BKE_idprop.hh.

Enumeration Type Documentation

eIDPropertyUIDataType

enum eIDPropertyUIDataType

Enumerator
IDP_UI_DATA_TYPE_UNSUPPORTED	Other properties types that don't support RNA UI data.
IDP_UI_DATA_TYPE_INT	IDP_INT or IDP_ARRAY with subtype IDP_INT.
IDP_UI_DATA_TYPE_FLOAT	IDP_FLOAT and IDP_DOUBLE or IDP_ARRAY properties with a float or double sub-types.
IDP_UI_DATA_TYPE_STRING	IDP_STRING properties.
IDP_UI_DATA_TYPE_ID	IDP_ID.
IDP_UI_DATA_TYPE_BOOLEAN	IDP_BOOLEAN or IDP_ARRAY with subtype IDP_BOOLEAN.

Definition at line 362 of file BKE_idprop.hh.

Function Documentation

IDP_AddToGroup()

bool IDP_AddToGroup	(	IDProperty *	group,
		IDProperty *	prop )

This function has a sanity check to make sure ID properties with the same name don't get added to the group.

The sanity check just means the property is not added to the group if another property exists with the same name; the client code using ID properties then needs to detect this (the function that adds new properties to groups, IDP_AddToGroup, returns false if a property can't be added to the group, and true if it can) and free the property.

Definition at line 725 of file idprop.cc.

References BLI_addtail(), BLI_assert, IDProperty::data, IDPropertyData::group, IDP_GetPropertyFromGroup(), IDP_GROUP, IDProperty::len, IDProperty::name, and IDProperty::type.

Referenced by bc_set_IDPropertyMatrix(), BKE_keyconfig_pref_set_select_mouse(), camera_write_cycles_compatibility_data_create(), blender::bke::create_auto_smooth_modifier(), blender::io::usd::ensure_usd_source_path_prop(), blender::bke::idprop::IDPGroupSerializer::entry_to_idprop(), blender::bke::tests::IDSubDataTestData::IDSubDataTestData(), IMB_metadata_set_field(), keymap_update_brushes_handle_add_item(), keymap_update_brushes_handle_remove_item(), blender::bke::node_update_asset_metadata(), operator_last_properties_init_impl(), blender::io::fbx::read_ufbx_property(), blender::ed::geometry::replace_strings_with_id_pointers(), RNA_property_boolean_set(), RNA_property_boolean_set_array(), RNA_property_collection_add(), RNA_property_enum_set(), RNA_property_float_set(), RNA_property_float_set_array(), RNA_property_int_set(), RNA_property_int_set_array(), RNA_property_pointer_add(), RNA_property_string_set(), RNA_property_string_set_bytes(), blender::io::usd::set_bool_prop(), blender::io::usd::set_double_prop(), blender::io::usd::set_float_prop(), blender::io::usd::set_int_prop(), blender::io::usd::set_string_prop(), shortcut_get_operator_property(), shortcut_property_from_rna(), texture_paint_image_from_view_exec(), ui_but_event_operator_string_from_menu(), ui_but_event_operator_string_from_panel(), ui_but_event_property_operator_string(), blender::nodes::update_input_properties_from_node_tree(), blender::nodes::update_output_properties_from_node_tree(), version_cycles_property_int_set(), and version_geometry_nodes_add_attribute_input_settings().

IDP_AppendArray()

void IDP_AppendArray	(	IDProperty *	prop,
		IDProperty *	item )

Definition at line 138 of file idprop.cc.

References BLI_assert, IDP_IDPARRAY, IDP_ResizeIDPArray(), IDP_SetIndexArray(), IDProperty::len, and IDProperty::type.

Referenced by BPy_IDProperty_Map_ValidateAndCreate(), and RNA_property_collection_add().

IDP_AssignID()

void IDP_AssignID	(	IDProperty *	prop,
		ID *	id,
		int	flag )

Parameters

flag	the ID creation/copying flags (LIB_ID_CREATE_...), same as passed to BKE_id_copy_ex.

Definition at line 538 of file idprop.cc.

References BLI_assert, IDProperty::data, flag, ID::flag, ID_FLAG_EMBEDDED_DATA, id_us_min(), id_us_plus(), IDP_ID, IDP_Id, LIB_ID_CREATE_NO_USER_REFCOUNT, IDPropertyData::pointer, and IDProperty::type.

Referenced by idp_from_DatablockPointer(), and RNA_property_pointer_set().

IDP_AssignString()

void IDP_AssignString	(	IDProperty *	prop,
		const char *	st )

Definition at line 431 of file idprop.cc.

References IDP_AssignStringMaxSize().

Referenced by blender::nodes::attribute_search_exec_fn(), collection_exporter_copy(), IMB_metadata_set_field(), blender::nodes::layer_name_search_exec_fn(), blender::nodes::old_id_property_type_matches_socket_convert_to_new_string(), and version_mesh_crease_generic().

IDP_AssignStringMaxSize()

void IDP_AssignStringMaxSize	(	IDProperty *	prop,
		const char *	st,
		size_t	st_maxncpy )

Parameters

st	The string to assign. Doesn't need to be null terminated when clamped by maxncpy.
maxncpy	The maximum size of the string (including the \0 terminator). When zero, this is the equivalent of passing in strlen(st) + 1

Definition at line 413 of file idprop.cc.

References BLI_assert, BLI_strnlen(), IDProperty::data, IDP_ResizeArray(), IDP_STRING, IDP_String, IDP_STRING_SUB_BYTE, IDPropertyData::pointer, IDProperty::subtype, and IDProperty::type.

Referenced by IDP_AssignString(), idp_from_PyBytes(), idp_from_PyUnicode(), RNA_property_string_set(), blender::nodes::update_input_properties_from_node_tree(), and blender::nodes::update_output_properties_from_node_tree().

IDP_BlendReadData_impl()

void IDP_BlendReadData_impl	(	BlendDataReader *	reader,
		IDProperty **	prop,
		const char *	caller_func_id )

Definition at line 1665 of file idprop.cc.

References IDP_DirectLinkGroup(), IDP_GROUP, and printf.

IDP_BlendWrite()

void IDP_BlendWrite	(	BlendWriter *	writer,
		const IDProperty *	prop )

Definition at line 1453 of file idprop.cc.

References BLO_write_struct, and IDP_WriteProperty_OnlyData().

Referenced by BKE_asset_metadata_write(), BKE_collection_blend_write_nolib(), BKE_id_blend_write(), BKE_pose_blend_write(), BKE_screen_view3d_shading_blend_write(), BKE_time_markers_blend_write(), BKE_view_layer_blend_write(), blender::blend_write(), IDP_WriteArray(), IDP_WriteGroup(), blender::bke::node_interface::item_types::item_write_data(), blender::bke::node_tree_blend_write(), blender::seq::strip_write_data_cb(), workspace_blend_write(), write_bone(), write_bone_collection(), write_keymapitem(), blender::bke::write_node_socket(), blender::bke::forward_compat::write_node_socket_interface(), write_uilist(), and write_userdef().

IDP_ClearProperty()

void IDP_ClearProperty

(

IDProperty *

prop

)

Definition at line 1249 of file idprop.cc.

References IDProperty::data, IDP_FreePropertyContent(), IDProperty::len, IDPropertyData::pointer, and IDProperty::totallen.

Referenced by blo_update_defaults_scene(), BPy_IDGroup_clear(), IDP_Reset(), WM_gizmo_properties_clear(), and WM_operator_properties_clear().

IDP_coerce_to_double_or_zero()

double IDP_coerce_to_double_or_zero

(

const IDProperty *

prop

)

Return a double from an IDProperty with a compatible type. This should be avoided, but it's sometimes necessary, for example when legacy files have incorrect property types.

Definition at line 823 of file idprop.cc.

References IDP_Bool, IDP_BOOLEAN, IDP_DOUBLE, IDP_Double, IDP_FLOAT, IDP_Float, IDP_INT, IDP_Int, and IDProperty::type.

Referenced by version_idproperty_move_data_float().

IDP_coerce_to_float_or_zero()

float IDP_coerce_to_float_or_zero

(

const IDProperty *

prop

)

Return a float from an IDProperty with a compatible type. This should be avoided, but it's sometimes necessary, for example when legacy files have incorrect property types.

Definition at line 839 of file idprop.cc.

References IDP_Bool, IDP_BOOLEAN, IDP_DOUBLE, IDP_Double, IDP_FLOAT, IDP_Float, IDP_INT, IDP_Int, and IDProperty::type.

Referenced by version_idproperty_move_data_float().

IDP_coerce_to_int_or_zero()

int IDP_coerce_to_int_or_zero

(

const IDProperty *

prop

)

Return an int from an IDProperty with a compatible type. This should be avoided, but it's sometimes necessary, for example when legacy files have incorrect property types.

Definition at line 807 of file idprop.cc.

References IDP_Bool, IDP_BOOLEAN, IDP_DOUBLE, IDP_Double, IDP_FLOAT, IDP_Float, IDP_INT, IDP_Int, and IDProperty::type.

Referenced by version_idproperty_move_data_float(), and version_idproperty_move_data_int().

IDP_CopyIDPArray()

IDProperty * IDP_CopyIDPArray	(	const IDProperty *	array,
		int	flag )

Parameters

flag	the ID creation/copying flags (LIB_ID_CREATE_...), same as passed to BKE_id_copy_ex.

Definition at line 78 of file idprop.cc.

References BLI_assert, array< T, alignment >::data(), IDProperty::data, flag, GETPROP, i, IDP_CopyProperty_ex(), IDP_IDPARRAY, IDProperty::len, MEM_dupallocN(), MEM_freeN(), MEM_mallocN(), and IDPropertyData::pointer.

Referenced by IDP_CopyProperty_ex().

IDP_CopyProperty()

IDProperty * IDP_CopyProperty

(

const IDProperty *

prop

)

Definition at line 873 of file idprop.cc.

References IDP_CopyProperty_ex().

Referenced by BKE_pose_channel_copy_data(), BKE_scene_duplicate(), camera_write_cycles_compatibility_data_create(), collection_exporter_copy(), blender::ed::object::collection_exporter_export(), blender::bke::forward_compat::construct_interface_as_legacy_sockets(), copy_pchan(), ED_armature_from_edit(), ed_marker_duplicate_apply(), ED_screen_user_menu_item_add_operator(), fcurves_to_pchan_links_get(), IDP_CopyPropertyContent(), IDP_ReplaceGroupInGroup(), IDP_SyncGroupTypes(), IDP_SyncGroupValues(), IMB_metadata_copy(), blender::bke::greasepencil::convert::legacy_gpencil_to_grease_pencil(), make_boneList_recursive(), operator_last_properties_init_impl(), pose_backup_create(), pose_bone_do_paste(), blender::ed::geometry::replace_strings_with_id_pointers(), scene_copy_data(), shortcut_get_operator_property(), uiDefSearchButO_ptr(), version_make_socket_stub(), view3d_duplicate(), wm_gizmo_create(), wm_keymap_item_copy(), wm_keymap_item_find(), wm_keymap_item_find_in_keymap(), WM_keymap_item_restore_to_default(), wm_operator_close_file_dialog_if_needed(), wm_operator_create(), WM_operator_last_properties_store(), WM_operator_name_call_ptr_with_depends_on_cursor(), wm_save_file_overwrite_dialog(), WM_toolsystem_ref_properties_init_for_keymap(), and wm_xr_actionmap_item_copy().

IDP_CopyProperty_ex()

IDProperty * IDP_CopyProperty_ex	(	const IDProperty *	prop,
		int	flag )

Parameters

flag	the ID creation/copying flags (LIB_ID_CREATE_...), same as passed to BKE_id_copy_ex.

Definition at line 855 of file idprop.cc.

References flag, IDP_ARRAY, IDP_CopyArray(), IDP_CopyGroup(), IDP_CopyID(), IDP_CopyIDPArray(), IDP_CopyString(), idp_generic_copy(), IDP_GROUP, IDP_ID, IDP_IDPARRAY, IDP_STRING, and IDProperty::type.

Referenced by blender::animrig::ANIM_bonecoll_array_copy_no_membership(), BKE_copy_time_markers(), BKE_libblock_copy_in_lib(), BKE_pose_copy_data_ex(), BKE_view_layer_copy_data(), Freestyle::BlenderStrokeRenderer::BlenderStrokeRenderer(), copy_and_update_ownership(), copy_bone_collection(), copy_bonechildren(), blender::copy_data(), ED_armature_ebone_listbase_copy(), IDP_CopyArray(), IDP_CopyGroup(), IDP_CopyIDPArray(), IDP_CopyProperty(), IDP_MergeGroup_ex(), blender::bke::node_interface::item_types::item_copy(), join_armature_remap_collection(), blender::bke::node_copy_with_mapping(), blender::bke::node_socket_copy(), blender::seq::strip_duplicate(), version_copy_socket(), and version_forward_compat_system_idprops().

IDP_CopyPropertyContent()

void IDP_CopyPropertyContent	(	IDProperty *	dst,
		const IDProperty *	src )

Copy content from source IDProperty into destination one, freeing destination property's content first.

Definition at line 878 of file idprop.cc.

References IDP_CopyProperty(), IDP_FreeProperty(), IDProperty::next, and IDProperty::prev.

Referenced by screen_user_menu_draw(), uiItemsFullEnumO_items(), blender::nodes::update_input_properties_from_node_tree(), and blender::nodes::update_output_properties_from_node_tree().

IDP_EnsureProperties()

IDProperty * IDP_EnsureProperties

(

ID *

id

)

Ensure the Group property that contains the id properties for ID id exists & return it.

Definition at line 892 of file idprop.cc.

References IDP_GROUP, MEM_callocN(), and ID::properties.

Referenced by camera_write_cycles_compatibility_data_create(), blender::io::usd::ensure_usd_source_path_prop(), blender::io::usd::get_usd_source_path(), blender::io::fbx::read_custom_properties(), blender::io::usd::set_id_props_from_prim(), and texture_paint_image_from_view_exec().

IDP_EnumItemFind()

const IDPropertyUIDataEnumItem * IDP_EnumItemFind

(

const IDProperty *

prop

)

Definition at line 463 of file idprop.cc.

References BLI_assert, IDPropertyUIDataInt::enum_items, IDPropertyUIDataInt::enum_items_num, IDP_INT, IDP_Int, IDProperty::type, and IDProperty::ui_data.

Referenced by idp_repr_fn_recursive().

IDP_EnumItemsValidate()

bool IDP_EnumItemsValidate	(	const IDPropertyUIDataEnumItem *	items,
		int	items_num,
		void(*	error_fn )(const char *) )

Definition at line 480 of file idprop.cc.

References blender::Set< Key, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add(), i, IDPropertyUIDataEnumItem::identifier, blender::Set< Key, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::reserve(), and IDPropertyUIDataEnumItem::value.

Referenced by blender::nodes::id_property_int_update_enum_items(), and idprop_ui_data_update_int().

IDP_EqualsProperties()

bool IDP_EqualsProperties	(	const IDProperty *	prop1,
		const IDProperty *	prop2 )

Definition at line 996 of file idprop.cc.

References IDP_EqualsProperties_ex().

Referenced by ED_screen_user_menu_item_find_operator(), wm_xr_operator_test_event(), and wm_xr_session_modal_action_test().

IDP_EqualsProperties_ex()

bool IDP_EqualsProperties_ex	(	const IDProperty *	prop1,
		const IDProperty *	prop2,
		bool	is_strict )

Parameters

is_strict

When false treat missing items as a match.

Definition at line 905 of file idprop.cc.

References BLI_assert_unreachable, IDProperty::data, fabsf, false, IDPropertyData::group, i, IDP_ARRAY, IDP_Array, IDP_Bool, IDP_BOOLEAN, IDP_DOUBLE, IDP_Double, IDP_EqualsProperties_ex(), IDP_FLOAT, IDP_Float, IDP_GetPropertyFromGroup(), IDP_GROUP, IDP_ID, IDP_Id, IDP_IDPARRAY, IDP_IDPArray, IDP_INT, IDP_Int, IDP_print(), idp_size_table, IDP_STRING, IDP_String, IDProperty::len, LISTBASE_FOREACH, max_ff(), IDProperty::name, printf, STREQLEN, IDProperty::subtype, and IDProperty::type.

Referenced by IDP_EqualsProperties(), IDP_EqualsProperties_ex(), ui_key_event_property_match(), and wm_keymap_item_find_in_keymap().

IDP_foreach_property()

void IDP_foreach_property	(	IDProperty *	id_property_root,
		int	type_filter,
		blender::FunctionRef< void(IDProperty *id_property)>	callback )

Loop through all ID properties in hierarchy of given id_property_root included.

Note

Container types (groups and arrays) are processed after applying the callback on them.

Parameters

type_filter

If not 0, only apply callback on properties of matching types, see IDP_TYPE_FILTER_ enum in DNA_ID.h.

References str.

Referenced by armature_foreach_id_bone(), armature_foreach_id_bone_collection(), armature_foreach_id_editbone(), blender::deg::DepsgraphNodeBuilder::build_idproperties(), blender::deg::DepsgraphRelationBuilder::build_idproperties(), blender::find_dependencies_from_settings(), blender::foreach_ID_link(), blender::ed::geometry::gather_input_ids(), blender::bke::node_interface::item_types::item_foreach_id(), library_foreach_ID_link(), blender::bke::library_foreach_node_socket(), blender::bke::node_node_foreach_id(), object_foreach_id(), blender::ed::geometry::replace_inputs_evaluated_data_blocks(), blender::ed::geometry::replace_strings_with_id_pointers(), scene_foreach_id(), and strip_foreach_member_id_cb().

IDP_FreeArray()

void IDP_FreeArray

(

IDProperty *

prop

)

Definition at line 250 of file idprop.cc.

References IDProperty::data, idp_resize_group_array(), MEM_freeN(), and IDPropertyData::pointer.

Referenced by IDP_FreePropertyContent_ex().

IDP_FreeFromGroup()

void IDP_FreeFromGroup	(	IDProperty *	group,
		IDProperty *	prop )

Removes the property from the group and frees it.

Definition at line 760 of file idprop.cc.

References IDP_FreeProperty(), and IDP_RemoveFromGroup().

Referenced by BPy_IDGroup_pop(), BPy_Wrap_SetMapItem(), IDP_SyncGroupTypes(), IMB_metadata_set_field(), pyrna_struct_pop(), rna_idproperty_free(), RNA_property_pointer_remove(), rna_property_rna_or_id_get(), RNA_struct_idprops_unset(), and version_idproperty_ui_data().

IDP_FreeProperty()

void IDP_FreeProperty

(

IDProperty *

prop

)

Definition at line 1243 of file idprop.cc.

References IDP_FreePropertyContent(), and MEM_freeN().

Referenced by BKE_addon_free(), BKE_area_region_free(), BKE_blender_user_menu_item_free(), BKE_collection_exporter_free_data(), BKE_pose_backup_free(), BKE_pose_channel_copy_data(), BKE_workspace_tool_remove(), blo_do_versions_280(), blo_do_versions_400(), bone_free(), camera_write_cycles_compatibility_data_clear(), blender::ed::object::collection_exporter_export(), do_versions_after_linking_280(), ED_armature_edit_free(), IDP_CopyPropertyContent(), IDP_FreeFromGroup(), idp_from_PyMapping(), idp_from_PySequence_Fast(), IDP_ReplaceGroupInGroup(), idp_resize_group_array(), IDP_SyncGroupTypes(), IDP_SyncGroupValues(), IMB_metadata_free(), keymap_item_free(), keymap_item_free(), blender::bke::node_update_asset_metadata(), blender::bke::idprop::IDPropertyDeleter::operator()(), operator_last_properties_init_impl(), operatortype_ghash_free_cb(), pose_clear_user_transforms_exec(), poseAnim_mapping_free(), pyrna_struct_dealloc(), pyrna_struct_id_properties_clear(), scene_free_data(), shortcut_free_operator_property(), blender::bke::idprop::tests::TEST(), blender::bke::idprop::tests::TEST(), blender::bke::idprop::tests::TEST(), blender::bke::idprop::tests::test_convert_idprop_from_value(), ui_but_event_operator_string_from_menu(), ui_but_event_operator_string_from_panel(), ui_but_event_property_operator_string(), ui_handler_wait_for_input_remove(), blender::update_id_properties_from_node_group(), userdef_free_keyconfig_prefs(), view3d_free(), wm_drop_item_free_data(), wm_free_operator_properties_callback(), WM_gizmo_properties_free(), wm_keymap_item_find(), wm_keymap_item_find_in_keymap(), wm_keymap_item_free_data(), WM_keymap_item_properties_reset(), WM_keymap_item_restore_to_default(), WM_keymap_remove_item(), WM_operator_free(), WM_operator_last_properties_store(), WM_operator_properties_free(), WM_operatortype_last_properties_clear_all(), WM_operatortype_remove_ptr(), and wm_xr_data_free().

IDP_FreeProperty_ex()

void IDP_FreeProperty_ex	(	IDProperty *	prop,
		bool	do_id_user )

Definition at line 1237 of file idprop.cc.

References IDP_FreePropertyContent_ex(), and MEM_freeN().

Referenced by blender::animrig::ANIM_bonecoll_array_free(), ANIM_bonecoll_free(), BKE_armature_bonelist_free(), BKE_armature_editbonelist_free(), BKE_pose_channel_free_ex(), BKE_view_layer_free_ex(), ED_armature_ebone_listbase_free(), blender::free_data(), IDP_ReplaceInGroup_ex(), blender::bke::forward_compat::legacy_socket_interface_free(), and blender::ed::geometry::run_node_group_exec().

IDP_FreePropertyContent()

void IDP_FreePropertyContent

(

IDProperty *

prop

)

Definition at line 1232 of file idprop.cc.

References IDP_FreePropertyContent_ex().

Referenced by ed_marker_delete_exec(), IDP_ClearProperty(), IDP_FreeProperty(), IDP_ResizeIDPArray(), and IDP_SetIndexArray().

IDP_FreePropertyContent_ex()

void IDP_FreePropertyContent_ex	(	IDProperty *	prop,
		bool	do_id_user )

Note

This will free allocated data, all child properties of arrays and groups, and unlink IDs! But it does not free the actual IDProperty struct itself.

Definition at line 1205 of file idprop.cc.

References id_us_min(), IDP_ARRAY, IDP_FreeArray(), IDP_FreeGroup(), IDP_FreeIDPArray(), IDP_FreeString(), IDP_GROUP, IDP_ID, IDP_Id, IDP_IDPARRAY, IDP_STRING, IDP_ui_data_free(), IDProperty::type, and IDProperty::ui_data.

Referenced by BKE_libblock_free_data(), IDP_FreeGroup(), IDP_FreeIDPArray(), IDP_FreeProperty_ex(), IDP_FreePropertyContent(), blender::bke::node_interface::item_types::item_free(), blender::bke::node_free_node(), blender::bke::node_socket_free(), preview_id_copy_free(), scene_free_markers(), and blender::seq::seq_strip_free_ex().

IDP_FreeString()

void IDP_FreeString

(

IDProperty *

prop

)

Definition at line 438 of file idprop.cc.

References BLI_assert, IDProperty::data, IDP_STRING, MEM_freeN(), IDPropertyData::pointer, and IDProperty::type.

Referenced by IDP_FreePropertyContent_ex().

IDP_GetIndexArray()

IDProperty * IDP_GetIndexArray	(	IDProperty *	prop,
		int	index )

Definition at line 131 of file idprop.cc.

References BLI_assert, GETPROP, IDP_IDPARRAY, and IDProperty::type.

Referenced by RNA_property_collection_add().

IDP_GetProperties()

IDProperty * IDP_GetProperties

(

ID *

id

)

Get the Group property that contains the id properties for ID id.

Definition at line 887 of file idprop.cc.

Referenced by blo_update_defaults_scene(), camera_write_cycles_compatibility_data_create(), do_versions_idproperty_ui_data(), preview_id_copy_free(), proj_paint_state_viewport_init(), texture_paint_camera_project_exec(), version_bonelayers_to_bonecollections(), version_cycles_properties_from_ID(), and version_cycles_visibility_properties_from_ID().

IDP_GetPropertyFromGroup() [1/2]

IDProperty * IDP_GetPropertyFromGroup	(	const IDProperty *	prop,
		blender::StringRef	name )

Definition at line 766 of file idprop.cc.

References BLI_assert, BLI_listbase_find(), IDProperty::data, IDPropertyData::group, IDP_GROUP, and IDProperty::type.

Referenced by blender::nodes::attribute_search_exec_fn(), bc_get_IDProperty(), BKE_asset_metadata_idprop_find(), BKE_keyconfig_pref_set_select_mouse(), blo_do_versions_280(), BPy_IDGroup_Contains(), BPy_IDGroup_get(), BPy_IDGroup_Map_GetItem(), BPy_IDGroup_pop(), BPy_IDProperty_Map_ValidateAndCreate(), BPy_Wrap_SetMapItem(), collection_exporter_copy(), blender::io::usd::ensure_usd_source_path_prop(), find_rna_property_rgba(), blender::ed::object::geometry_nodes_input_attribute_toggle_exec(), blender::io::usd::get_usd_source_path(), IDP_AddToGroup(), IDP_EqualsProperties_ex(), IDP_GetPropertyTypeFromGroup(), IDP_InsertToGroup(), IDP_MergeGroup_ex(), IDP_ReplaceInGroup(), IDP_ReplaceInGroup_ex(), IDP_SyncGroupTypes(), idprops_ensure_named_group(), IMB_metadata_get_field(), IMB_metadata_set_field(), keymap_item_has_invalid_wm_context_data_path(), keymap_update_brushes_handle_add_item(), keymap_update_brushes_handle_remove_item(), blender::nodes::layer_name_search_exec_fn(), operator_last_properties_init_impl(), proj_paint_state_viewport_init(), pyrna_struct_contains(), pyrna_struct_get(), pyrna_struct_id_properties_ui(), pyrna_struct_pop(), pyrna_struct_subscript(), rna_idproperty_find(), rna_idproperty_free(), rna_path_parse(), RNA_struct_idprops_unset(), blender::ed::object::shade_auto_smooth_exec(), blender::nodes::update_input_properties_from_node_tree(), blender::nodes::update_output_properties_from_node_tree(), version_bonelayers_to_bonecollections(), version_idproperty_move_data_float(), version_idproperty_move_data_int(), version_idproperty_move_data_string(), version_idproperty_ui_data(), WM_operator_last_properties_init(), WM_toolsystem_ref_properties_get_ex(), WM_toolsystem_ref_properties_get_idprops(), and WM_toolsystem_ref_properties_init_for_keymap().

IDP_GetPropertyFromGroup() [2/2]

IDProperty * IDP_GetPropertyFromGroup	(	const IDProperty *	prop,
		const char *	name )

This is a slightly more efficient version of the function above in the when there are lots of properties. It can be faster because it avoids computing the length of everything that the string is compared to. Also see #140706.

Definition at line 773 of file idprop.cc.

References BLI_assert, BLI_findstring(), IDProperty::data, IDPropertyData::group, IDP_GROUP, offsetof, and IDProperty::type.

IDP_GetPropertyTypeFromGroup()

IDProperty * IDP_GetPropertyTypeFromGroup	(	const IDProperty *	prop,
		blender::StringRef	name,
		char	type )

Same as IDP_GetPropertyFromGroup but ensure the type matches.

Definition at line 779 of file idprop.cc.

References IDP_GetPropertyFromGroup(), and IDProperty::type.

Referenced by camera_write_cycles_compatibility_data_create(), texture_paint_camera_project_exec(), version_cycles_properties_from_ID(), version_cycles_properties_from_render_layer(), version_cycles_properties_from_view_layer(), version_cycles_property_float(), version_cycles_property_int(), version_cycles_property_int_set(), and version_cycles_visibility_properties_from_ID().

IDP_InsertToGroup()

bool IDP_InsertToGroup	(	IDProperty *	group,
		IDProperty *	previous,
		IDProperty *	pnew )

This is the same as IDP_AddToGroup, only you pass an item in the group list to be inserted after.

References ATTR_WARN_UNUSED_RESULT, and flag.

IDP_MergeGroup()

void IDP_MergeGroup	(	IDProperty *	dest,
		const IDProperty *	src,
		bool	do_overwrite )

If a property is missing in dest, add it. Do it recursively.

Definition at line 720 of file idprop.cc.

References IDP_MergeGroup_ex().

Referenced by BPy_IDGroup_update(), gizmo_tweak_start_and_finish(), IDP_Reset(), operator_last_properties_init_impl(), WM_gizmo_operator_invoke(), and WM_toolsystem_ref_properties_init_for_keymap().

IDP_MergeGroup_ex()

void IDP_MergeGroup_ex	(	IDProperty *	dest,
		const IDProperty *	src,
		bool	do_overwrite,
		int	flag )

If a property is missing in dest, add it. Do it recursively.

Parameters

flag	the ID creation/copying flags (LIB_ID_CREATE_...), same as passed to BKE_id_copy_ex.

Definition at line 679 of file idprop.cc.

References BLI_addtail(), BLI_assert, copy(), IDProperty::data, flag, IDPropertyData::group, IDP_CopyProperty_ex(), IDP_GetPropertyFromGroup(), IDP_GROUP, IDP_MergeGroup_ex(), IDP_ReplaceInGroup_ex(), IDProperty::len, LISTBASE_FOREACH, IDProperty::name, and IDProperty::type.

Referenced by IDP_MergeGroup(), IDP_MergeGroup_ex(), and version_forward_compat_system_idprops().

IDP_New()

IDProperty * IDP_New	(	char	type,
		const IDPropertyTemplate *	val,
		blender::StringRef	name,
		eIDPropertyFlag	flags = {} )

Allocate a new IDProperty.

This function takes three arguments: the ID property type, a union which defines its initial value, and a name.

The union is simple to use; see the top of BKE_idprop.h for its definition. An example of using this function:

IDPropertyTemplate val;
IDProperty *group, *idgroup, *color;
group = IDP_New(IDP_GROUP, val, "group1"); // groups don't need a template.
 
val.array.len = 4
val.array.type = IDP_FLOAT;
color = IDP_New(IDP_ARRAY, val, "color1");
 
idgroup = IDP_EnsureProperties(some_id);
IDP_AddToGroup(idgroup, color);
IDP_AddToGroup(idgroup, group);

Note that you MUST either attach the id property to an id property group with IDP_AddToGroup or MEM_freeN the property, doing anything else might result in a memory leak.

Definition at line 1001 of file idprop.cc.

References IDPropertyTemplate::array, BLI_assert, CLOG_ERROR, blender::StringRefBase::copy_utf8_truncated(), IDPropertyTemplate::d, IDProperty::data, DEFAULT_ALLOC_FOR_NULL_STRINGS, ELEM, IDPropertyTemplate::f, IDProperty::flag, IDPropertyTemplate::i, IDPropertyTemplate::id, id_us_plus(), IDP_ARRAY, IDP_BOOLEAN, IDP_DOUBLE, IDP_FLOAT, IDP_GROUP, IDP_ID, IDP_Id, IDP_INT, idp_size_table, IDP_STRING, IDP_String, IDP_STRING_SUB_BYTE, IDP_STRING_SUB_UTF8, IDProperty::len, IDPropertyTemplate::len, LOG, MEM_calloc_arrayN(), MEM_callocN(), MEM_malloc_arrayN(), IDProperty::name, IDPropertyData::pointer, IDPropertyTemplate::str, IDPropertyTemplate::string, IDProperty::subtype, IDPropertyTemplate::subtype, IDProperty::totallen, IDProperty::type, IDPropertyTemplate::type, and IDPropertyData::val.

Referenced by blender::bke::idprop::array_create(), blender::ed::object::collection_exporter_add_exec(), blender::bke::idprop::create(), blender::bke::idprop::create(), blender::bke::idprop::create(), blender::bke::idprop::create(), blender::bke::idprop::create_bool(), blender::bke::idprop::create_group(), blender::io::usd::ensure_usd_source_path_prop(), idp_from_PyBytes(), idp_from_PySequence_Buffer(), idp_from_PySequence_Fast(), idp_from_PyUnicode(), blender::io::fbx::read_ufbx_property(), RNA_property_boolean_set_array(), RNA_property_enum_set(), RNA_property_string_set_bytes(), blender::io::usd::set_bool_prop(), blender::io::usd::set_double_prop(), blender::io::usd::set_float_prop(), blender::io::usd::set_int_prop(), and blender::io::usd::set_string_prop().

IDP_NewIDPArray()

IDProperty * IDP_NewIDPArray

(

blender::StringRef

name

)

Note

as a start to move away from the stupid IDP_New function, this type has its own allocation function.

Definition at line 68 of file idprop.cc.

References blender::StringRefBase::copy_utf8_truncated(), IDP_IDPARRAY, IDProperty::len, MEM_callocN(), IDProperty::name, and IDProperty::type.

Referenced by idp_from_PySequence_Fast(), and RNA_property_collection_add().

IDP_NewString()

IDProperty * IDP_NewString	(	const char *	st,
		blender::StringRef	name,
		eIDPropertyFlag	flags = {} )

Definition at line 391 of file idprop.cc.

References IDP_NewStringMaxSize().

Referenced by blender::bke::idprop::create().

IDP_NewStringMaxSize()

IDProperty * IDP_NewStringMaxSize	(	const char *	st,
		size_t	st_maxncpy,
		blender::StringRef	name,
		eIDPropertyFlag	flags = {} )

Parameters

st	The string to assign. Doesn't need to be null terminated when clamped by maxncpy.
name	The property name.
maxncpy	The maximum size of the string (including the \0 terminator). When zero, this is the equivalent of passing in strlen(st) + 1

Returns

The new string property.

Definition at line 355 of file idprop.cc.

References BLI_assert, BLI_strnlen(), blender::StringRefBase::copy_utf8_truncated(), IDProperty::data, DEFAULT_ALLOC_FOR_NULL_STRINGS, IDProperty::flag, IDP_STRING, IDP_String, IDProperty::len, MEM_callocN(), MEM_malloc_arrayN(), IDProperty::name, IDPropertyData::pointer, IDProperty::totallen, and IDProperty::type.

Referenced by IDP_NewString(), RNA_property_string_set(), ui_but_event_operator_string_from_menu(), ui_but_event_operator_string_from_panel(), and blender::nodes::update_output_properties_from_node_tree().

IDP_print()

void IDP_print

(

const IDProperty *

prop

)

Definition at line 256 of file idprop_utils.cc.

References IDP_reprN(), MEM_freeN(), and printf.

Referenced by IDP_EqualsProperties_ex(), wm_keymap_item_find(), and wm_keymap_item_find_in_keymap().

IDP_RemoveFromGroup()

bool void IDP_RemoveFromGroup	(	IDProperty *	group,
		IDProperty *	prop )

Note

this does not free the property!

To free the property, you have to do: #IDP_FreeProperty(prop);

Definition at line 751 of file idprop.cc.

References BLI_assert, BLI_findindex(), BLI_remlink(), IDProperty::data, IDPropertyData::group, IDP_GROUP, IDProperty::len, and IDProperty::type.

Referenced by IDP_FreeFromGroup().

IDP_ReplaceGroupInGroup()

void IDP_ReplaceGroupInGroup	(	IDProperty *	dest,
		const IDProperty *	src )

Replaces all properties with the same name in a destination group from a source group.

Definition at line 630 of file idprop.cc.

References BLI_addtail(), BLI_assert, BLI_insertlinkreplace(), copy(), IDProperty::data, ListBase::first, IDPropertyData::group, IDP_CopyProperty(), IDP_CopyProperty(), IDP_FreeProperty(), IDP_GROUP, IDProperty::len, LISTBASE_FOREACH, IDProperty::name, IDProperty::next, STREQ, and IDProperty::type.

Referenced by wm_operator_create().

IDP_ReplaceInGroup()

void IDP_ReplaceInGroup	(	IDProperty *	group,
		IDProperty *	prop )

Definition at line 672 of file idprop.cc.

References IDP_GetPropertyFromGroup(), IDP_ReplaceInGroup_ex(), and IDProperty::name.

Referenced by BKE_asset_metadata_idprop_ensure(), RNA_property_pointer_set(), ui_but_event_operator_string_from_panel(), and WM_operator_last_properties_store().

IDP_ReplaceInGroup_ex()

void IDP_ReplaceInGroup_ex	(	IDProperty *	group,
		IDProperty *	prop,
		IDProperty *	prop_exist,
		int	flag )

Checks if a property with the same name as prop exists, and if so replaces it. Use this to preserve order!

Parameters

flag	the ID creation/copying flags (LIB_ID_CREATE_...), same as passed to BKE_id_copy_ex.

Definition at line 654 of file idprop.cc.

References BLI_addtail(), BLI_assert, BLI_insertlinkreplace(), IDProperty::data, flag, IDPropertyData::group, IDP_FreeProperty_ex(), IDP_GetPropertyFromGroup(), IDP_GROUP, IDProperty::len, LIB_ID_CREATE_NO_USER_REFCOUNT, IDProperty::name, and IDProperty::type.

Referenced by BPy_IDProperty_Map_ValidateAndCreate(), IDP_MergeGroup_ex(), IDP_ReplaceInGroup(), idprops_ensure_named_group(), and RNA_property_pointer_set().

IDP_repr_fn()

void IDP_repr_fn	(	const IDProperty *	prop,
		void(*	str_append_fn )(void *user_data, const char *str, uint str_len),
		void *	user_data )

Definition at line 229 of file idprop_utils.cc.

References idp_repr_fn_recursive(), state, and str.

Referenced by IDP_reprN().

IDP_reprN()

char * IDP_reprN	(	const IDProperty *	prop,
		uint *	r_len )

Definition at line 244 of file idprop_utils.cc.

References BLI_dynstr_free(), BLI_dynstr_get_cstring(), BLI_dynstr_get_len(), BLI_dynstr_new(), IDP_repr_fn(), and repr_str().

Referenced by IDP_print(), and keymap_handler_log_kmi_op_str().

IDP_Reset()

void IDP_Reset	(	IDProperty *	prop,
		const IDProperty *	reference )

Definition at line 1256 of file idprop.cc.

References IDP_ClearProperty(), and IDP_MergeGroup().

IDP_ResizeArray()

void IDP_ResizeArray	(	IDProperty *	prop,
		int	newlen )

This function works for strings too!

Definition at line 213 of file idprop.cc.

References IDProperty::data, IDP_ARRAY_REALLOC_LIMIT, idp_resize_group_array(), idp_size_table, IDProperty::len, MEM_recallocN, IDPropertyData::pointer, IDProperty::subtype, and IDProperty::totallen.

Referenced by IDP_AssignStringMaxSize(), and RNA_property_string_set_bytes().

IDP_ResizeIDPArray()

void IDP_ResizeIDPArray	(	IDProperty *	prop,
		int	newlen )

Definition at line 146 of file idprop.cc.

References BLI_assert, IDProperty::data, GETPROP, i, IDP_ARRAY_REALLOC_LIMIT, IDP_FreePropertyContent(), IDP_IDPARRAY, IDProperty::len, len, MEM_recallocN, IDPropertyData::pointer, IDProperty::totallen, and IDProperty::type.

Referenced by IDP_AppendArray(), RNA_property_collection_clear(), and RNA_property_collection_remove().

IDP_SetIndexArray()

void IDP_SetIndexArray	(	IDProperty *	prop,
		int	index,
		IDProperty *	item )

Shallow copies item.

Definition at line 115 of file idprop.cc.

References BLI_assert, GETPROP, IDP_FreePropertyContent(), IDP_IDPARRAY, IDProperty::len, and IDProperty::type.

Referenced by IDP_AppendArray().

IDP_SyncGroupTypes()

void IDP_SyncGroupTypes	(	IDProperty *	dest,
		const IDProperty *	src,
		bool	do_arraylen )

Definition at line 607 of file idprop.cc.

References BLI_insertlinkreplace(), IDProperty::data, ELEM, IDPropertyData::group, IDP_ARRAY, IDP_CopyProperty(), IDP_FreeFromGroup(), IDP_FreeProperty(), IDP_GetPropertyFromGroup(), IDP_GROUP, IDP_IDPARRAY, IDP_SyncGroupTypes(), IDProperty::len, LISTBASE_FOREACH_MUTABLE, IDProperty::name, IDProperty::subtype, and IDProperty::type.

Referenced by IDP_SyncGroupTypes(), and WM_operator_type_set().

IDP_SyncGroupValues()

void IDP_SyncGroupValues	(	IDProperty *	dest,
		const IDProperty *	src )

Sync values from one group to another when values name and types match, copy the values, else ignore.

Note

Was used for syncing proxies.

Definition at line 578 of file idprop.cc.

References BLI_assert, BLI_findstring(), BLI_insertlinkreplace(), IDProperty::data, IDPropertyData::group, IDP_BOOLEAN, IDP_CopyProperty(), IDP_DOUBLE, IDP_FLOAT, IDP_FreeProperty(), IDP_GROUP, IDP_INT, IDP_SyncGroupValues(), LISTBASE_FOREACH, offsetof, and IDProperty::type.

Referenced by BKE_pose_backup_restore(), IDP_SyncGroupValues(), pose_bone_do_paste(), and poseAnim_mapping_reset().

IDP_TryConvertUIData()

IDPropertyUIData * IDP_TryConvertUIData	(	IDPropertyUIData *	src,
		eIDPropertyUIDataType	src_type,
		eIDPropertyUIDataType	dst_type )

Convert UI data like default arrays from the old type to the new type as possible. Takes ownership of the input data; it can return it directly if the types match.

Definition at line 1769 of file idprop.cc.

References IDPropertyUIDataBool::base, IDPropertyUIDataFloat::base, IDPropertyUIDataInt::base, convert_base_ui_data(), IDPropertyUIDataBool::default_array, IDPropertyUIDataFloat::default_array, IDPropertyUIDataInt::default_array, IDPropertyUIDataBool::default_array_len, IDPropertyUIDataFloat::default_array_len, IDPropertyUIDataInt::default_array_len, IDPropertyUIDataBool::default_value, IDPropertyUIDataFloat::default_value, IDPropertyUIDataInt::default_value, i, IDP_UI_DATA_TYPE_BOOLEAN, IDP_UI_DATA_TYPE_FLOAT, IDP_UI_DATA_TYPE_ID, IDP_UI_DATA_TYPE_INT, IDP_UI_DATA_TYPE_STRING, IDP_UI_DATA_TYPE_UNSUPPORTED, IDPropertyUIDataFloat::max, IDPropertyUIDataInt::max, MEM_malloc_arrayN(), IDPropertyUIDataFloat::min, IDPropertyUIDataInt::min, IDPropertyUIDataFloat::soft_max, IDPropertyUIDataInt::soft_max, IDPropertyUIDataFloat::soft_min, IDPropertyUIDataInt::soft_min, IDPropertyUIDataFloat::step, IDPropertyUIDataInt::step, and ui_data_free().

Referenced by BPy_IDProperty_Map_ValidateAndCreate().

IDP_type_str() [1/2]

const char * IDP_type_str

(

const IDProperty *

prop

)

Definition at line 308 of file idprop_utils.cc.

References IDP_type_str(), IDProperty::subtype, and IDProperty::type.

IDP_type_str() [2/2]

const char * IDP_type_str	(	eIDPropertyType	type,
		short	sub_type )

Definition at line 264 of file idprop_utils.cc.

References BLI_assert_unreachable, IDP_ARRAY, IDP_BOOLEAN, IDP_DOUBLE, IDP_FLOAT, IDP_GROUP, IDP_ID, IDP_IDPARRAY, IDP_INT, IDP_STRING, IDP_STRING_SUB_BYTE, and IDP_STRING_SUB_UTF8.

Referenced by BPy_IDProperty_Map_ValidateAndCreate(), and IDP_type_str().

IDP_ui_data_copy()

IDPropertyUIData * IDP_ui_data_copy

(

const IDProperty *

prop

)

Definition at line 258 of file idprop.cc.

References BLI_strdup(), BLI_strdup_null(), IDPropertyUIDataBool::default_array, IDPropertyUIDataFloat::default_array, IDPropertyUIDataInt::default_array, IDPropertyUIDataString::default_value, IDPropertyUIData::description, IDPropertyUIDataEnumItem::description, IDPropertyUIDataInt::enum_items, IDPropertyUIDataInt::enum_items_num, i, IDPropertyUIDataEnumItem::identifier, IDP_ui_data_type(), IDP_UI_DATA_TYPE_BOOLEAN, IDP_UI_DATA_TYPE_FLOAT, IDP_UI_DATA_TYPE_ID, IDP_UI_DATA_TYPE_INT, IDP_UI_DATA_TYPE_STRING, IDP_UI_DATA_TYPE_UNSUPPORTED, MEM_dupallocN(), IDPropertyUIDataEnumItem::name, and IDProperty::ui_data.

Referenced by BPy_IDPropertyUIManager_update_from(), and idp_generic_copy().

IDP_ui_data_ensure()

IDPropertyUIData * IDP_ui_data_ensure

(

IDProperty *

prop

)

Definition at line 1751 of file idprop.cc.

References IDP_ui_data_type(), IDProperty::ui_data, and ui_data_alloc().

Referenced by BPy_IDIDPropertyUIManager_as_dict(), BPy_IDPropertyUIManager_update(), blender::bke::create_auto_smooth_modifier(), blender::nodes::id_name_or_value_prop(), blender::nodes::id_property_create_from_socket(), RNA_property_float_set_default(), RNA_property_int_set_default(), blender::nodes::update_input_properties_from_node_tree(), blender::nodes::update_output_properties_from_node_tree(), and version_idproperty_ui_data().

IDP_ui_data_free()

void IDP_ui_data_free

(

IDProperty *

prop

)

Definition at line 1199 of file idprop.cc.

References IDP_ui_data_type(), IDProperty::ui_data, and ui_data_free().

Referenced by BPy_IDPropertyUIManager_clear(), BPy_IDPropertyUIManager_update_from(), IDP_FreePropertyContent_ex(), and blender::nodes::update_output_properties_from_node_tree().

IDP_ui_data_free_unique_contents()

void IDP_ui_data_free_unique_contents	(	IDPropertyUIData *	ui_data,
		eIDPropertyUIDataType	type,
		const IDPropertyUIData *	other )

Free allocated pointers in the UI data that isn't shared with the UI data in the other argument. Useful for returning early on failure when updating UI data in place, or when replacing a subset of the UI data's allocated pointers.

Definition at line 1109 of file idprop.cc.

References IDPropertyUIDataBool::default_array, IDPropertyUIDataFloat::default_array, IDPropertyUIDataInt::default_array, IDPropertyUIDataString::default_value, IDPropertyUIData::description, IDPropertyUIDataInt::enum_items, IDP_int_ui_data_free_enum_items(), IDP_UI_DATA_TYPE_BOOLEAN, IDP_UI_DATA_TYPE_FLOAT, IDP_UI_DATA_TYPE_ID, IDP_UI_DATA_TYPE_INT, IDP_UI_DATA_TYPE_STRING, IDP_UI_DATA_TYPE_UNSUPPORTED, and MEM_SAFE_FREE.

Referenced by idprop_ui_data_update_bool(), idprop_ui_data_update_float(), idprop_ui_data_update_id(), idprop_ui_data_update_int(), and idprop_ui_data_update_string().

IDP_ui_data_supported()

bool IDP_ui_data_supported

(

const IDProperty *

prop

)

Definition at line 1703 of file idprop.cc.

References IDP_ui_data_type(), and IDP_UI_DATA_TYPE_UNSUPPORTED.

Referenced by BPy_IDIDPropertyUIManager_as_dict(), BPy_IDPropertyUIManager_clear(), BPy_IDPropertyUIManager_update(), BPy_IDPropertyUIManager_update_from(), pyrna_struct_id_properties_ui(), and version_idproperty_ui_data().

IDP_ui_data_type()

eIDPropertyUIDataType IDP_ui_data_type

(

const IDProperty *

prop

)

Definition at line 1681 of file idprop.cc.

References ELEM, IDP_ARRAY, IDP_BOOLEAN, IDP_DOUBLE, IDP_FLOAT, IDP_ID, IDP_INT, IDP_STRING, IDP_UI_DATA_TYPE_BOOLEAN, IDP_UI_DATA_TYPE_FLOAT, IDP_UI_DATA_TYPE_ID, IDP_UI_DATA_TYPE_INT, IDP_UI_DATA_TYPE_STRING, IDP_UI_DATA_TYPE_UNSUPPORTED, IDProperty::subtype, and IDProperty::type.

Referenced by BPy_IDIDPropertyUIManager_as_dict(), BPy_IDProperty_Map_ValidateAndCreate(), BPy_IDPropertyUIManager_update(), IDP_ui_data_copy(), IDP_ui_data_ensure(), IDP_ui_data_free(), IDP_ui_data_supported(), idprop_ui_data_update_bool(), idprop_ui_data_update_float(), idprop_ui_data_update_id(), idprop_ui_data_update_int(), idprop_ui_data_update_string(), read_ui_data(), RNA_property_boolean_get_default(), RNA_property_boolean_get_default_array(), version_idproperty_ui_data(), and write_ui_data().