BKE_idtype.hh File Reference

#include <optional>
#include "BLI_color_types.hh"
#include "BLI_function_ref.hh"
#include "BLI_implicit_sharing_ptr.hh"
#include "BLI_sys_types.h"

Go to the source code of this file.

Classes
struct	IDCacheKey
struct	IDTypeForeachColorFunctionCallback
struct	IDTypeInfo

Macros
#define	BKE_idtype_idcode_is_localizable   BKE_idtype_idcode_is_linkable

Typedefs
using	IDTypeInitDataFunction = void (*)(ID *id)
using	IDTypeCopyDataFunction
using	IDTypeFreeDataFunction = void (*)(ID *id)
using	IDTypeMakeLocalFunction = void (*)(Main *bmain, ID *id, int flags)
using	IDTypeForeachIDFunction = void (*)(ID *id, LibraryForeachIDData *data)
using	IDTypeForeachCacheFunctionCallback
using	IDTypeForeachCacheFunction
using	IDTypeForeachPathFunction = void (*)(ID *id, BPathForeachPathData *bpath_data)
using	IDTypeForeachColorFunction = void (*)(ID *id, const IDTypeForeachColorFunctionCallback &cb)
using	IDTypeEmbeddedOwnerPointerGetFunction = ID **(*)(ID * id, bool debug_relationship_assert)
using	IDTypeBlendWriteFunction = void (*)(BlendWriter *writer, ID *id, const void *id_address)
using	IDTypeBlendReadDataFunction = void (*)(BlendDataReader *reader, ID *id)
using	IDTypeBlendReadAfterLiblinkFunction = void (*)(BlendLibReader *reader, ID *id)
using	IDTypeBlendReadUndoPreserve = void (*)(BlendLibReader *reader, ID *id_new, ID *id_old)
using	IDTypeLibOverrideApplyPost = void (*)(ID *id_dst, ID *id_src)

Enumerations
enum	{   IDTYPE_FLAGS_NO_COPY = 1 << 0 , IDTYPE_FLAGS_NO_LIBLINKING = 1 << 1 , IDTYPE_FLAGS_ONLY_APPEND = 1 << 2 , IDTYPE_FLAGS_APPEND_IS_REUSABLE = 1 << 3 ,   IDTYPE_FLAGS_NO_ANIMDATA = 1 << 4 , IDTYPE_FLAGS_NO_MEMFILE_UNDO = 1 << 5 , IDTYPE_FLAGS_NEVER_UNUSED = 1 << 6 }
enum	eIDTypeInfoCacheCallbackFlags { IDTYPE_CACHE_CB_FLAGS_PERSISTENT = 1 << 0 }

Functions
uint	BKE_idtype_cache_key_hash (const void *key_v)
bool	BKE_idtype_cache_key_cmp (const void *key_a_v, const void *key_b_v)
void	BKE_idtype_init ()
const IDTypeInfo *	BKE_idtype_get_info_from_idtype_index (const int idtype_index)
const IDTypeInfo *	BKE_idtype_get_info_from_idcode (short id_code)
const IDTypeInfo *	BKE_idtype_get_info_from_id (const ID *id)
const char *	BKE_idtype_idcode_to_name (short idcode)
const char *	BKE_idtype_idcode_to_name_plural (short idcode)
const char *	BKE_idtype_idcode_to_translation_context (short idcode)
bool	BKE_idtype_idcode_is_valid (short idcode)
bool	BKE_idtype_idcode_is_linkable (short idcode)
bool	BKE_idtype_idcode_is_only_appendable (short idcode)
bool	BKE_idtype_idcode_append_is_reusable (short idcode)
short	BKE_idtype_idcode_from_name (const char *idtype_name)
int	BKE_idtype_idcode_to_index (short idcode)
int	BKE_idtype_idfilter_to_index (uint64_t id_filter)
short	BKE_idtype_index_to_idcode (int idtype_index)
uint64_t	BKE_idtype_index_to_idfilter (int idtype_index)
uint64_t	BKE_idtype_idcode_to_idfilter (short idcode)
short	BKE_idtype_idfilter_to_idcode (uint64_t idfilter)
short	BKE_idtype_idcode_iter_step (int *idtype_index)
void	BKE_idtype_id_foreach_cache (ID *id, IDTypeForeachCacheFunctionCallback function_callback, void *user_data)

Variables
IDTypeInfo	IDType_ID_SCE
IDTypeInfo	IDType_ID_LI
IDTypeInfo	IDType_ID_OB
IDTypeInfo	IDType_ID_ME
IDTypeInfo	IDType_ID_CU_LEGACY
IDTypeInfo	IDType_ID_MB
IDTypeInfo	IDType_ID_MA
IDTypeInfo	IDType_ID_TE
IDTypeInfo	IDType_ID_IM
IDTypeInfo	IDType_ID_LT
IDTypeInfo	IDType_ID_LA
IDTypeInfo	IDType_ID_CA
IDTypeInfo	IDType_ID_KE
IDTypeInfo	IDType_ID_WO
IDTypeInfo	IDType_ID_SCR
IDTypeInfo	IDType_ID_VF
IDTypeInfo	IDType_ID_TXT
IDTypeInfo	IDType_ID_SPK
IDTypeInfo	IDType_ID_SO
IDTypeInfo	IDType_ID_GR
IDTypeInfo	IDType_ID_AR
IDTypeInfo	IDType_ID_AC
IDTypeInfo	IDType_ID_NT
IDTypeInfo	IDType_ID_BR
IDTypeInfo	IDType_ID_PA
IDTypeInfo	IDType_ID_GD_LEGACY
IDTypeInfo	IDType_ID_WM
IDTypeInfo	IDType_ID_MC
IDTypeInfo	IDType_ID_MSK
IDTypeInfo	IDType_ID_LS
IDTypeInfo	IDType_ID_PAL
IDTypeInfo	IDType_ID_PC
IDTypeInfo	IDType_ID_CF
IDTypeInfo	IDType_ID_WS
IDTypeInfo	IDType_ID_LP
IDTypeInfo	IDType_ID_CV
IDTypeInfo	IDType_ID_PT
IDTypeInfo	IDType_ID_VO
IDTypeInfo	IDType_ID_GP
IDTypeInfo	IDType_ID_LINK_PLACEHOLDER

Detailed Description

ID type structure, helping to factorize common operations and data for all data-block types.

Definition in file BKE_idtype.hh.

Macro Definition Documentation

BKE_idtype_idcode_is_localizable

#define BKE_idtype_idcode_is_localizable   BKE_idtype_idcode_is_linkable

Definition at line 397 of file BKE_idtype.hh.

Referenced by template_ID().

Typedef Documentation

IDTypeBlendReadAfterLiblinkFunction

using IDTypeBlendReadAfterLiblinkFunction = void (*)(BlendLibReader *reader, ID *id)

Definition at line 140 of file BKE_idtype.hh.

IDTypeBlendReadDataFunction

using IDTypeBlendReadDataFunction = void (*)(BlendDataReader *reader, ID *id)

Definition at line 139 of file BKE_idtype.hh.

IDTypeBlendReadUndoPreserve

using IDTypeBlendReadUndoPreserve = void (*)(BlendLibReader *reader, ID *id_new, ID *id_old)

Definition at line 142 of file BKE_idtype.hh.

IDTypeBlendWriteFunction

using IDTypeBlendWriteFunction = void (*)(BlendWriter *writer, ID *id, const void *id_address)

Definition at line 138 of file BKE_idtype.hh.

IDTypeCopyDataFunction

using IDTypeCopyDataFunction

Initial value:

void (*)(
   Main *bmain, std::optional<Library *> owner_library, ID *id_dst, const ID *id_src, int flag)

Parameters

flag	Copying options (see BKE_lib_id.hh's LIB_ID_COPY_... flags for more).

Definition at line 93 of file BKE_idtype.hh.

IDTypeEmbeddedOwnerPointerGetFunction

using IDTypeEmbeddedOwnerPointerGetFunction = ID **(*)(ID * id, bool debug_relationship_assert)

Callback returning the address of the pointer to the owner ID, for embedded (and Shape-key) ones.

Parameters

debug_relationship_assert

usually the owner <-> embedded relation pointers should be fully valid, and can be asserted on. But in some cases, they are not (fully) valid, e.g when copying an ID and all of its embedded data.

Definition at line 136 of file BKE_idtype.hh.

IDTypeForeachCacheFunction

using IDTypeForeachCacheFunction

Initial value:

void (*)(ID *id,
                                           IDTypeForeachCacheFunctionCallback function_callback,
                                           void *user_data)

Definition at line 112 of file BKE_idtype.hh.

IDTypeForeachCacheFunctionCallback

using IDTypeForeachCacheFunctionCallback

Initial value:

 
void (*)(ID *id, const IDCacheKey *cache_key, void **cache_p, uint flags, void *user_data)

Definition at line 110 of file BKE_idtype.hh.

IDTypeForeachColorFunction

using IDTypeForeachColorFunction = void (*)(ID *id, const IDTypeForeachColorFunctionCallback &cb)

Definition at line 126 of file BKE_idtype.hh.

IDTypeForeachIDFunction

using IDTypeForeachIDFunction = void (*)(ID *id, LibraryForeachIDData *data)

Definition at line 101 of file BKE_idtype.hh.

IDTypeForeachPathFunction

using IDTypeForeachPathFunction = void (*)(ID *id, BPathForeachPathData *bpath_data)

Definition at line 116 of file BKE_idtype.hh.

IDTypeFreeDataFunction

using IDTypeFreeDataFunction = void (*)(ID *id)

Definition at line 96 of file BKE_idtype.hh.

IDTypeInitDataFunction

using IDTypeInitDataFunction = void (*)(ID *id)

Definition at line 90 of file BKE_idtype.hh.

IDTypeLibOverrideApplyPost

using IDTypeLibOverrideApplyPost = void (*)(ID *id_dst, ID *id_src)

Definition at line 144 of file BKE_idtype.hh.

IDTypeMakeLocalFunction

using IDTypeMakeLocalFunction = void (*)(Main *bmain, ID *id, int flags)

Parameters

flags

See BKE_lib_id.hh's LIB_ID_MAKELOCAL_... flags.

Definition at line 99 of file BKE_idtype.hh.

Enumeration Type Documentation

anonymous enum

anonymous enum

IDTypeInfo.flags.

Enumerator
IDTYPE_FLAGS_NO_COPY	Indicates that the given IDType does not support copying.
IDTYPE_FLAGS_NO_LIBLINKING	Indicates that the given IDType does not support linking/appending from a library file.
IDTYPE_FLAGS_ONLY_APPEND	Indicates that the given IDType should not be directly linked from a library file, but may be appended. NOTE: Mutually exclusive with IDTYPE_FLAGS_NO_LIBLINKING.
IDTYPE_FLAGS_APPEND_IS_REUSABLE	Allow to re-use an existing local ID with matching weak library reference instead of creating a new copy of it, when appending. See also LibraryWeakReference in DNA_ID.h.
IDTYPE_FLAGS_NO_ANIMDATA	Indicates that the given IDType does not have animation data.
IDTYPE_FLAGS_NO_MEMFILE_UNDO	Indicates that the given IDType is not handled through memfile (aka global) undo. Note This currently only affect local data-blocks. Current readfile undo code expects these data-blocks to not be used by any 'regular' data-blocks.
IDTYPE_FLAGS_NEVER_UNUSED	Indicates that the given IDType is considered as unused. This is used for some 'root' ID types which typically do not have any actual user (WM. Scene...). It prevents e.g. their deletion through the 'Purge' operation. Note This applies to local IDs. Linked data should essentially ignore this flag. In practice, currently, only the Scene ID can be linked among the never unused types. The implementation of the expected behaviors related to this characteristic is somewhat fragile and inconsistent currently. In most case though, code is expected to ensure that such IDs have at least an 'extra user' (ID_TAG_EXTRAUSER).

Definition at line 31 of file BKE_idtype.hh.

eIDTypeInfoCacheCallbackFlags

enum eIDTypeInfoCacheCallbackFlags

Enumerator
IDTYPE_CACHE_CB_FLAGS_PERSISTENT	Indicates to the callback that cache may be stored in the .blend file, so its pointer should not be cleared at read-time.

Definition at line 103 of file BKE_idtype.hh.

Function Documentation

BKE_idtype_cache_key_cmp()

bool BKE_idtype_cache_key_cmp	(	const void *	key_a_v,
		const void *	key_b_v )

Definition at line 36 of file idtype.cc.

References IDCacheKey::id_session_uid, and IDCacheKey::identifier.

Referenced by blo_cache_storage_init().

BKE_idtype_cache_key_hash()

uint BKE_idtype_cache_key_hash

(

const void *

key_v

)

Definition at line 28 of file idtype.cc.

References BLI_ghashutil_combine_hash(), BLI_ghashutil_uinthash(), hash, IDCacheKey::id_session_uid, and IDCacheKey::identifier.

Referenced by blo_cache_storage_init().

BKE_idtype_get_info_from_id()

const IDTypeInfo * BKE_idtype_get_info_from_id

(

const ID *

id

)

Definition at line 146 of file idtype.cc.

References BKE_idtype_get_info_from_idcode(), GS, and ID::name.

Referenced by absolute_convert_foreach_path_cb(), after_liblink_id_process(), blender::bke::asset_write_in_library(), BKE_bpath_foreach_path_id(), BKE_id_copy_in_lib(), BKE_id_owner_get(), BKE_idtype_id_foreach_cache(), BKE_lib_id_clear_library_data(), BKE_lib_id_make_local(), BKE_libblock_copy_in_lib(), BKE_libblock_free_datablock(), BKE_libblock_init_empty(), BKE_library_id_can_use_filter_id(), BKE_library_id_can_use_idtype(), blo_cache_storage_init(), blo_cache_storage_old_bmain_clear(), BLO_Write_IDBuffer::BLO_Write_IDBuffer(), blender::ed::asset::clear_id(), direct_link_id(), direct_link_id_common(), gather_local_ids_to_write(), id_swap(), IMB_colormanagement_working_space_convert(), lib_link_all(), lib_query_unused_ids_tag_recurse(), library_foreach_ID_link(), blender::ed::asset::mark_id(), blender::ed::space_node::node_find_create_data_block_value(), blender::ed::outliner::outliner_id_copy_tag(), read_libblock_undo_restore(), read_undo_reuse_noundo_local_ids(), relative_convert_foreach_path_cb(), RNA_struct_override_apply(), and write_id().

BKE_idtype_get_info_from_idcode()

const IDTypeInfo * BKE_idtype_get_info_from_idcode

(

short

id_code

)

Definition at line 141 of file idtype.cc.

References BKE_idtype_get_info_from_idtype_index(), and BKE_idtype_idcode_to_index().

Referenced by blender::bke::asset_root_path_for_save(), BKE_idtype_get_info_from_id(), BKE_idtype_id_foreach_cache(), BKE_idtype_idcode_append_is_reusable(), BKE_idtype_idcode_is_linkable(), BKE_idtype_idcode_is_only_appendable(), BKE_idtype_idcode_is_valid(), BKE_idtype_idcode_to_name(), BKE_idtype_idcode_to_name_plural(), BKE_idtype_idcode_to_translation_context(), BKE_libblock_get_alloc_info(), and id_type_can_have_animdata().

BKE_idtype_get_info_from_idtype_index()

const IDTypeInfo * BKE_idtype_get_info_from_idtype_index

(

const int

idtype_index

)

Definition at line 127 of file idtype.cc.

References BKE_idtype_idcode_to_index(), BLI_assert_msg, IDTypeInfo::id_code, id_types, and IDTypeInfo::name.

Referenced by BKE_idtype_get_info_from_idcode(), BKE_idtype_index_to_idcode(), BKE_idtype_index_to_idfilter(), get_alloc_name(), and setup_app_data().

BKE_idtype_id_foreach_cache()

void BKE_idtype_id_foreach_cache	(	ID *	id,
		IDTypeForeachCacheFunctionCallback	function_callback,
		void *	user_data )

Wrapper around IDTypeInfo foreach_cache that also handles embedded IDs.

Definition at line 379 of file idtype.cc.

References BKE_idtype_get_info_from_id(), BKE_idtype_get_info_from_idcode(), IDTypeInfo::foreach_cache, GS, bNodeTree::id, Collection::id, ID_NT, ID_SCE, Scene::master_collection, ID::name, and blender::bke::node_tree_from_id().

Referenced by blo_cache_storage_init(), blo_cache_storage_old_bmain_clear(), and direct_link_id().

BKE_idtype_idcode_append_is_reusable()

bool BKE_idtype_idcode_append_is_reusable

(

short

idcode

)

Check if an ID type can try to reuse and existing matching local one when being appended again.

Parameters

idcode

The IDType code to check.

Returns

Boolean, false when it cannot be re-used, true otherwise.

Definition at line 216 of file idtype.cc.

References BKE_idtype_get_info_from_idcode(), BLI_assert, IDTypeInfo::flags, IDTYPE_FLAGS_APPEND_IS_REUSABLE, and IDTYPE_FLAGS_NO_LIBLINKING.

Referenced by BKE_blendfile_append(), BKE_main_library_weak_reference_add_item(), BKE_main_library_weak_reference_create(), and blendfile_append_define_actions().

BKE_idtype_idcode_from_name()

short BKE_idtype_idcode_from_name

(

const char *

idtype_name

)

Convert an ID-type name into an idcode (ie. ID_SCE)

Parameters

idtype_name

The ID-type's "user visible name" to convert.

Returns

The idcode for the name, or 0 if invalid.

Definition at line 185 of file idtype.cc.

References BLI_assert, IDTypeInfo::id_code, and idtype_get_info_from_name().

Referenced by groupname_to_code(), imb_thumb_load_from_blend_id(), wm_id_linked_relocate_exec(), wm_link_append_exec(), and wm_link_append_item_poll().

BKE_idtype_idcode_is_linkable()

bool BKE_idtype_idcode_is_linkable

(

short

idcode

)

Check if an ID type is linkable.

Parameters

idcode

The IDType code to check.

Returns

Boolean, false when non linkable, true otherwise.

Definition at line 197 of file idtype.cc.

References BKE_idtype_get_info_from_idcode(), BLI_assert, IDTypeInfo::flags, and IDTYPE_FLAGS_NO_LIBLINKING.

Referenced by BKE_blendfile_library_relocate(), BKE_blendfile_link_append_context_item_idtypes_from_library_add(), BKE_id_can_be_asset(), BKE_lib_override_library_create_from_tag(), BKE_library_make_local(), BKE_main_library_weak_reference_create(), BLO_blendhandle_get_linkable_groups(), bpy_lib_enter(), bpy_lib_exit(), foreach_libblock_link_append_common_processing(), id_lib_extern(), id_lib_indirect_weak_link(), blender::ed::outliner::id_override_library_create_hierarchy_pre_process(), lib_id_expand_local_cb(), link_named_part(), blender::ed::outliner::outliner_id_relocate_invoke(), read_file_bhead_idname_map_create(), read_library_linked_id(), wm_link_append_item_poll(), write_file_handle(), write_id_direct_linked_data_process_cb(), and write_libraries().

BKE_idtype_idcode_is_only_appendable()

bool BKE_idtype_idcode_is_only_appendable

(

short

idcode

)

Check if an ID type is only appendable.

Parameters

idcode

The IDType code to check.

Returns

Boolean, false when also linkable, true when only appendable.

Definition at line 204 of file idtype.cc.

References BKE_idtype_get_info_from_idcode(), BLI_assert, IDTypeInfo::flags, IDTYPE_FLAGS_NO_LIBLINKING, and IDTYPE_FLAGS_ONLY_APPEND.

Referenced by wm_link_append_item_poll().

BKE_idtype_idcode_is_valid()

bool BKE_idtype_idcode_is_valid

(

short

idcode

)

Return if the ID code is a valid ID code.

Parameters

idcode

The code to check.

Returns

Boolean, 0 when invalid.

Definition at line 192 of file idtype.cc.

References BKE_idtype_get_info_from_idcode(), and true.

Referenced by blo_bhead_is_id_valid_type(), BLO_blendhandle_get_linkable_groups(), change_ID_pointer_to_real_ID_pointer_fd(), direct_link_id_common(), direct_link_id_embedded_id(), and link_named_part().

BKE_idtype_idcode_iter_step()

short BKE_idtype_idcode_iter_step

(

int *

idtype_index

)

Return an ID code and steps the index forward 1.

Parameters

index

start as 0.

Returns

the code, 0 when all codes have been returned.

Definition at line 373 of file idtype.cc.

References BKE_idtype_index_to_idcode(), and id_types.

Referenced by BKE_blendfile_link_append_context_item_idtypes_from_library_add(), BKE_main_idmap_create(), bpy_lib_enter(), bpy_lib_exit(), and main_namemap_validate_and_fix().

BKE_idtype_idcode_to_idfilter()

uint64_t BKE_idtype_idcode_to_idfilter

(

short

idcode

)

Convert an idcode into an idfilter (e.g. ID_OB -> FILTER_ID_OB).

Definition at line 363 of file idtype.cc.

References BKE_idtype_idcode_to_index(), and BKE_idtype_index_to_idfilter().

Referenced by blender::bke::id::IDRemapper::add(), blender::bke::id::IDRemapper::add_overwrite(), BKE_blendfile_link_append_context_item_idtypes_from_library_add(), BKE_library_id_can_use_idtype(), blender::ed::asset::filter_matches_asset(), is_filtered_id_file_type(), and previews_clear_exec().

BKE_idtype_idcode_to_index()

int BKE_idtype_idcode_to_index

(

short

idcode

)

Convert an idcode into an idtype_index (e.g. ID_OB -> INDEX_ID_OB).

Definition at line 228 of file idtype.cc.

References BR, CASE_IDINDEX, CV, ID_LINK_PLACEHOLDER, INDEX_ID_NULL, and LT.

Referenced by blender::deg::Depsgraph::add_id_node(), BKE_idtype_get_info_from_idcode(), BKE_idtype_get_info_from_idtype_index(), BKE_idtype_idcode_to_idfilter(), DEG_graph_id_type_tag(), DEG_id_type_any_exists(), DEG_id_type_updated(), UniqueName_Map::find_by_type(), lib_query_unused_ids_tag_id(), lib_query_unused_ids_untag_id(), read_libblock(), and blender::ed::outliner::tree_element_id_type_to_index().

BKE_idtype_idcode_to_name()

const char * BKE_idtype_idcode_to_name

(

short

idcode

)

Convert an idcode into a name.

Parameters

idcode

The code to convert.

Returns

A static string representing the name of the code.

Definition at line 164 of file idtype.cc.

References BKE_idtype_get_info_from_idcode(), BLI_assert, and IDTypeInfo::name.

Referenced by blender::ed::object::apply_objects_internal(), blender::bke::asset_edit_weak_reference_from_id(), blender::bke::asset_weak_reference_for_essentials(), blender::bke::asset_weak_reference_for_user_library(), BKE_id_new_in_lib(), BKE_id_new_name_validate(), BKE_id_new_nomain(), BKE_mesh_new_nomain(), BKE_pointcloud_new_nomain(), BLO_blendhandle_get_linkable_groups(), BPy_GeometrySet_static_from_evaluated_object(), BPy_InlineShaderNodes_static_from_light(), BPy_InlineShaderNodes_static_from_material(), BPy_InlineShaderNodes_static_from_world(), datadropper_init(), delete_key_button_exec(), blender::animrig::delete_keyframe(), filelist_readjob_list_lib_add_from_indexer_entries(), filelist_readjob_main_assets_add_items(), blender::asset_system::AssetRepresentation::library_relative_identifier(), blender::ed::object::mode_set_ex(), pydriver_error(), pyrna_struct_keyframe_delete(), read_library_linked_id(), rna_id_write_error(), blender::ed::vse::sequencer_report_duplicates(), setup_app_data(), UI_context_copy_to_selected_list(), ui_tooltip_data_from_search_item_tooltip_data(), uiTemplatePreview(), blender::ed::outliner::unused_message_gen(), wm_id_linked_relocate_exec(), and WM_operator_drop_load_path().

BKE_idtype_idcode_to_name_plural()

const char * BKE_idtype_idcode_to_name_plural

(

short

idcode

)

Convert an idcode into a name (plural).

Parameters

idcode

The code to convert.

Returns

A static string representing the name of the code.

Definition at line 171 of file idtype.cc.

References BKE_idtype_get_info_from_idcode(), BLI_assert, and IDTypeInfo::name_plural.

Referenced by blender::bke::asset_weak_reference_for_essentials(), bpy_lib_enter(), bpy_lib_exit(), bpy_lib_exit_lapp_context_items_cb(), idp_repr_fn_recursive(), blender::ed::outliner::outliner_idcode_to_plural(), pyrna_prop_repr_ex(), pyrna_struct_repr(), RNA_path_full_ID_py(), blender::ed::vse::sequencer_report_duplicates(), blender::ed::outliner::unused_message_gen(), and WM_drag_get_item_name().

BKE_idtype_idcode_to_translation_context()

const char * BKE_idtype_idcode_to_translation_context

(

short

idcode

)

Convert an idcode into its translations' context.

Parameters

idcode

The code to convert.

Returns

A static string representing the i18n context of the code.

Definition at line 178 of file idtype.cc.

References BKE_idtype_get_info_from_idcode(), BLI_assert, BLT_I18NCONTEXT_DEFAULT, and IDTypeInfo::translation_context.

BKE_idtype_idfilter_to_idcode()

short BKE_idtype_idfilter_to_idcode

(

uint64_t

idfilter

)

Convert an idfilter into an idcode (e.g. FILTER_ID_OB -> ID_OB).

Definition at line 368 of file idtype.cc.

References BKE_idtype_idfilter_to_index(), and BKE_idtype_index_to_idcode().

BKE_idtype_idfilter_to_index()

int BKE_idtype_idfilter_to_index

(

uint64_t

id_filter

)

Convert an id_filter into an idtype_index (e.g. FILTER_ID_OB -> INDEX_ID_OB).

Definition at line 286 of file idtype.cc.

References BR, CASE_IDINDEX, CV, and LT.

Referenced by BKE_idtype_idfilter_to_idcode().

BKE_idtype_index_to_idcode()

short BKE_idtype_index_to_idcode

(

int

idtype_index

)

Convert an idtype_index into an idcode (e.g. INDEX_ID_OB -> ID_OB).

Definition at line 341 of file idtype.cc.

References BKE_idtype_get_info_from_idtype_index(), BLI_assert_unreachable, and IDTypeInfo::id_code.

Referenced by BKE_idtype_idcode_iter_step(), BKE_idtype_idfilter_to_idcode(), and blender::ed::outliner::unused_message_gen().

BKE_idtype_index_to_idfilter()

uint64_t BKE_idtype_index_to_idfilter

(

int

idtype_index

)

Convert an idtype_index into an idfilter (e.g. INDEX_ID_OB -> FILTER_ID_OB).

Definition at line 352 of file idtype.cc.

References BKE_idtype_get_info_from_idtype_index(), BLI_assert_unreachable, and IDTypeInfo::id_filter.

Referenced by BKE_idtype_idcode_to_idfilter().

BKE_idtype_init()

void BKE_idtype_init

(

)

Definition at line 121 of file idtype.cc.

References id_type_init().

Referenced by blender::bke::greasepencil::tests::GreasePencilIDTestContext::GreasePencilIDTestContext(), blender::ed::greasepencil::tests::GreasePencilIDTestContext::GreasePencilIDTestContext(), blender::bke::tests::LibIDMainSortTestContext::LibIDMainSortTestContext(), main(), blender::bke::image::partial_update::ImagePartialUpdateTest::SetUp(), BlendfileLoadingBaseTest::SetUpTestCase(), blender::animrig::nla::tests::NLASlottedActionTest::SetUpTestSuite(), blender::animrig::tests::ActionFCurveMoveTest::SetUpTestSuite(), blender::animrig::tests::ActionFilterTest::SetUpTestSuite(), blender::animrig::tests::ActionIteratorsTest::SetUpTestSuite(), blender::animrig::tests::ActionLayersTest::SetUpTestSuite(), blender::animrig::tests::ActionLegacyTest::SetUpTestSuite(), blender::animrig::tests::ActionQueryTest::SetUpTestSuite(), blender::animrig::tests::AnimationEvaluationTest::SetUpTestSuite(), blender::animrig::tests::AnimDrawTest::SetUpTestSuite(), blender::animrig::tests::KeyframingTest::SetUpTestSuite(), blender::animrig::tests::PoseTest::SetUpTestSuite(), blender::asset_system::tests::AssetLibraryTestBase::SetUpTestSuite(), blender::bke::tests::ArmatureDeformTest::SetUpTestSuite(), blender::bke::tests::BMainTest::SetUpTestSuite(), blender::bke::tests::BPathTest::SetUpTestSuite(), blender::bke::tests::ImageTest::SetUpTestSuite(), blender::bke::tests::LibQueryTest::SetUpTestSuite(), blender::bke::tests::LibRemapTest::SetUpTestSuite(), blender::bke::tests::PaintBVHTest::SetUpTestSuite(), blender::bke::tests::SceneTest::SetUpTestSuite(), blender::ed::sculpt_paint::tests::MeshTests::SetUpTestSuite(), blender::ed::sculpt_paint::undo::tests::SculptUndoTest::SetUpTestSuite(), blender::editor::animation::tests::KeylistSummaryTest::SetUpTestSuite(), blender::geometry::tests::RealizeInstancesTest::SetUpTestSuite(), blender::interface::tests::CopyDriversToSelected::SetUpTestSuite(), blender::io::obj::OBJCurvesTest::SetUpTestSuite(), blender::nodes::tests::BundleTest::SetUpTestSuite(), blender::nodes::tests::NodeTest::SetUpTestSuite(), BrushTest::SetUpTestSuite(), blender::animrig::tests::ArmatureBoneCollections::TearDown(), blender::animrig::tests::ArmatureBoneCollectionsTestList::TearDown(), blender::bke::id::tests::TEST(), blender::bke::id::tests::TEST(), blender::bke::id::tests::TEST(), blender::bke::id::tests::TEST(), blender::bke::id::tests::TEST(), blender::bke::tests::TEST(), blender::bke::tests::TEST(), and blender::ed::animation::tests::TEST_F().

Variable Documentation

IDType_ID_AC

IDTypeInfo IDType_ID_AC

extern

Definition at line 742 of file blenkernel/intern/action.cc.

Referenced by id_type_init().

IDType_ID_AR

IDTypeInfo IDType_ID_AR

extern

Definition at line 503 of file blenkernel/intern/armature.cc.

IDType_ID_BR

IDTypeInfo IDType_ID_BR

extern

Definition at line 522 of file brush.cc.

IDType_ID_CA

IDTypeInfo IDType_ID_CA

extern

Definition at line 253 of file blenkernel/intern/camera.cc.

IDType_ID_CF

IDTypeInfo IDType_ID_CF

extern

Definition at line 124 of file cachefile.cc.

IDType_ID_CU_LEGACY

IDTypeInfo IDType_ID_CU_LEGACY

extern

Definition at line 285 of file curve.cc.

IDType_ID_CV

IDTypeInfo IDType_ID_CV

extern

Definition at line 153 of file blenkernel/intern/curves.cc.

IDType_ID_GD_LEGACY

IDTypeInfo IDType_ID_GD_LEGACY

extern

Definition at line 266 of file gpencil_legacy.cc.

IDType_ID_GP

IDTypeInfo IDType_ID_GP

extern

Definition at line 354 of file grease_pencil.cc.

IDType_ID_GR

IDTypeInfo IDType_ID_GR

extern

Definition at line 386 of file collection.cc.

IDType_ID_IM

IDTypeInfo IDType_ID_IM

extern

Definition at line 472 of file source/blender/blenkernel/intern/image.cc.

IDType_ID_KE

IDTypeInfo IDType_ID_KE

extern

Definition at line 171 of file key.cc.

IDType_ID_LA

IDTypeInfo IDType_ID_LA

extern

Definition at line 166 of file blenkernel/intern/light.cc.

IDType_ID_LI

IDTypeInfo IDType_ID_LI

extern

Definition at line 198 of file library.cc.

IDType_ID_LINK_PLACEHOLDER

IDTypeInfo IDType_ID_LINK_PLACEHOLDER

extern

Empty shell mostly, but needed for read code.

Definition at line 88 of file lib_id.cc.

Referenced by id_type_init().

IDType_ID_LP

IDTypeInfo IDType_ID_LP

extern

Definition at line 52 of file lightprobe.cc.

IDType_ID_LS

IDTypeInfo IDType_ID_LS

extern

Definition at line 658 of file linestyle.cc.

IDType_ID_LT

IDTypeInfo IDType_ID_LT

extern

Definition at line 163 of file lattice.cc.

IDType_ID_MA

IDTypeInfo IDType_ID_MA

extern

Definition at line 246 of file blenkernel/intern/material.cc.

IDType_ID_MB

IDTypeInfo IDType_ID_MB

extern

Definition at line 140 of file mball.cc.

IDType_ID_MC

IDTypeInfo IDType_ID_MC

extern

Definition at line 298 of file movieclip.cc.

IDType_ID_ME

IDTypeInfo IDType_ID_ME

extern

Definition at line 499 of file blenkernel/intern/mesh.cc.

IDType_ID_MSK

IDTypeInfo IDType_ID_MSK

extern

Definition at line 186 of file blenkernel/intern/mask.cc.

IDType_ID_NT

IDTypeInfo IDType_ID_NT

extern

Definition at line 2026 of file node.cc.

IDType_ID_OB

IDTypeInfo IDType_ID_OB

extern

Definition at line 1074 of file blenkernel/intern/object.cc.

IDType_ID_PA

IDTypeInfo IDType_ID_PA

extern

Definition at line 383 of file particle.cc.

IDType_ID_PAL

IDTypeInfo IDType_ID_PAL

extern

Definition at line 156 of file paint.cc.

IDType_ID_PC

IDTypeInfo IDType_ID_PC

extern

Definition at line 226 of file paint.cc.

IDType_ID_PT

IDTypeInfo IDType_ID_PT

extern

Definition at line 168 of file pointcloud.cc.

IDType_ID_SCE

IDTypeInfo IDType_ID_SCE

extern

Definition at line 1565 of file scene.cc.

Referenced by blender::bke::tests::TEST(), and blender::bke::tests::TEST().

IDType_ID_SCR

IDTypeInfo IDType_ID_SCR

extern

Definition at line 174 of file screen.cc.

IDType_ID_SO

IDTypeInfo IDType_ID_SO

extern

Definition at line 195 of file blenkernel/intern/sound.cc.

IDType_ID_SPK

IDTypeInfo IDType_ID_SPK

extern

Definition at line 51 of file speaker.cc.

IDType_ID_TE

IDTypeInfo IDType_ID_TE

extern

Definition at line 186 of file texture.cc.

IDType_ID_TXT

IDTypeInfo IDType_ID_TXT

extern

Definition at line 227 of file text.cc.

IDType_ID_VF

IDTypeInfo IDType_ID_VF

extern

Definition at line 165 of file vfont.cc.

IDType_ID_VO

IDTypeInfo IDType_ID_VO

extern

Definition at line 277 of file blenkernel/intern/volume.cc.

IDType_ID_WM

IDTypeInfo IDType_ID_WM

extern

Definition at line 225 of file wm.cc.

IDType_ID_WO

IDTypeInfo IDType_ID_WO

extern

Definition at line 185 of file blenkernel/intern/world.cc.

IDType_ID_WS

IDTypeInfo IDType_ID_WS

extern

Definition at line 178 of file workspace.cc.