#include <optional>
#include "BLI_compiler_attrs.h"
#include "BLI_set.hh"
#include "BLI_string_ref.hh"
#include "BLI_utildefines.h"
#include "BLI_vector.hh"
#include "DNA_ID.h"
#include "DNA_userdef_enums.h"

Classes
struct	IDNewNameResult

Macros
#define	MAIN_ID_SESSION_UID_UNSET 0

#define	MAX_ID_FULL_NAME (64 + 64 + 3 + 1) /* 64 is MAX_ID_NAME - 2 */

#define	MAX_ID_FULL_NAME_UI (MAX_ID_FULL_NAME + 3) /* Adds 'keycode' two letters at beginning. */

#define	IS_TAGGED(_id) ((_id) && (((ID *)_id)->tag & ID_TAG_DOIT))

Enumerations
enum	{ LIB_ID_CREATE_NO_MAIN = 1 << 0 , LIB_ID_CREATE_NO_USER_REFCOUNT = 1 << 1 , LIB_ID_CREATE_NO_ALLOCATE = 1 << 2 , LIB_ID_CREATE_NO_DEG_TAG = 1 << 8 , LIB_ID_CREATE_LOCAL = 1 << 9 , LIB_ID_COPY_SET_COPIED_ON_WRITE = 1 << 10 , LIB_ID_COPY_NO_PREVIEW = 1 << 17 , LIB_ID_COPY_CACHES = 1 << 18 , LIB_ID_COPY_NO_ANIMDATA = 1 << 19 , LIB_ID_COPY_NO_LIB_OVERRIDE = 1 << 21 , LIB_ID_COPY_NO_LIB_OVERRIDE_LOCAL_DATA_FLAG = 1 << 22 , LIB_ID_COPY_ACTIONS = 1 << 24 , LIB_ID_COPY_SHAPEKEY = 1 << 26 , LIB_ID_COPY_NODETREE_LOCALIZE = 1 << 27 , LIB_ID_COPY_RIGID_BODY_NO_COLLECTION_HANDLING = 1 << 28 , LIB_ID_COPY_ASSET_METADATA = 1 << 29 , LIB_ID_COPY_DEFAULT = LIB_ID_COPY_SHAPEKEY , LIB_ID_CREATE_LOCALIZE , LIB_ID_COPY_LOCALIZE }

enum class	IDNewNameMode { RenameExistingNever = 0 , RenameExistingAlways = 1 , RenameExistingSameRoot = 2 }

enum	eLibIDDuplicateFlags { LIB_ID_DUPLICATE_IS_SUBPROCESS = 1 << 0 , LIB_ID_DUPLICATE_IS_ROOT_ID = 1 << 1 }

enum	{ LIB_ID_FREE_NO_MAIN = 1 << 0 , LIB_ID_FREE_NO_USER_REFCOUNT = 1 << 1 , LIB_ID_FREE_NOT_ALLOCATED = 1 << 2 , LIB_ID_FREE_NO_DEG_TAG = 1 << 8 , LIB_ID_FREE_NO_UI_USER = 1 << 9 , LIB_ID_FREE_NO_NAMEMAP_REMOVE = 1 << 10 }

enum	{ LIB_ID_MAKELOCAL_FULL_LIBRARY = 1 << 0 , LIB_ID_MAKELOCAL_INDIRECT = 1 << 1 , LIB_ID_MAKELOCAL_FORCE_LOCAL = 1 << 8 , LIB_ID_MAKELOCAL_FORCE_COPY = 1 << 9 , LIB_ID_MAKELOCAL_ASSET_DATA_CLEAR = 1 << 16 , LIB_ID_MAKELOCAL_LIBOVERRIDE_CLEAR = 1 << 17 }

Functions
size_t	BKE_libblock_get_alloc_info (short type, const char **r_name)

void *	BKE_libblock_alloc_notest (short type) ATTR_WARN_UNUSED_RESULT

void *	BKE_libblock_alloc (Main bmain, short type, const char name, int flag) ATTR_WARN_UNUSED_RESULT

void *	BKE_libblock_alloc_in_lib (Main bmain, std::optional< Library > owner_library, short type, const char *name, int flag) ATTR_WARN_UNUSED_RESULT

void	BKE_libblock_init_empty (ID *id) ATTR_NONNULL(1)

void	BKE_libblock_runtime_reset_remapping_status (ID *id) ATTR_NONNULL(1)

void	BKE_lib_libblock_session_uid_ensure (ID *id)

void	BKE_lib_libblock_session_uid_renew (ID *id)

void *	BKE_id_new (Main bmain, short type, const char name)

void *	BKE_id_new_in_lib (Main bmain, std::optional< Library > owner_library, short type, const char *name)

void *	BKE_id_new_nomain (short type, const char *name)

void	BKE_libblock_copy_ex (Main bmain, const ID id, ID **new_id_p, int orig_flag)

void	BKE_libblock_copy_in_lib (Main bmain, std::optional< Library > owner_library, const ID id, const ID new_owner_id, ID **new_id_p, int orig_flag)

void *	BKE_libblock_copy (Main bmain, const ID id) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()

void	BKE_id_move_to_same_lib (Main &bmain, ID &id, const ID &owner_id)

IDNewNameResult	BKE_libblock_rename (Main &bmain, ID &id, blender::StringRefNull name, const IDNewNameMode mode=IDNewNameMode::RenameExistingNever)

IDNewNameResult	BKE_id_rename (Main &bmain, ID &id, blender::StringRefNull name, const IDNewNameMode mode=IDNewNameMode::RenameExistingNever)

ID *	BKE_libblock_find_name (Main bmain, short type, const char name, const std::optional< Library * > lib=std::nullopt) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()

ID *	BKE_libblock_find_session_uid (Main *bmain, short type, uint32_t session_uid)

ID *	BKE_libblock_find_name_and_library (Main bmain, short type, const char name, const char *lib_name)

ID *	BKE_libblock_find_name_and_library_filepath (Main bmain, short type, const char name, const char *lib_filepath_abs)

void	BKE_libblock_free_datablock (ID *id, int flag) ATTR_NONNULL()

void	BKE_libblock_free_data (ID *id, bool do_id_user) ATTR_NONNULL()

void	BKE_libblock_free_data_py (ID *id)

void	BKE_id_free_ex (Main bmain, void idv, int flag_orig, bool use_flag_from_idtag)

void	BKE_id_free (Main bmain, void idv)

void	BKE_id_free_us (Main bmain, void idv) ATTR_NONNULL()

void	BKE_id_delete (Main bmain, void idv) ATTR_NONNULL()

void	BKE_id_delete_ex (Main bmain, void idv, const int extra_remapping_flags) ATTR_NONNULL(1

void size_t	BKE_id_multi_tagged_delete (Main *bmain) ATTR_NONNULL()

size_t	BKE_id_multi_delete (Main bmain, blender::Set< ID > &ids_to_delete)

void	BKE_libblock_management_main_add (Main bmain, void idv)

void	BKE_libblock_management_main_remove (Main bmain, void idv)

void	BKE_libblock_management_usercounts_set (Main bmain, void idv)

void	BKE_libblock_management_usercounts_clear (Main bmain, void idv)

void	id_lib_extern (ID *id)

void	id_lib_indirect_weak_link (ID *id)

void	id_us_ensure_real (ID *id)

void	id_us_clear_real (ID *id)

void	id_us_plus_no_lib (ID *id)

void	id_us_plus (ID *id)

void	id_us_min (ID *id)

void	id_fake_user_set (ID *id)

void	id_fake_user_clear (ID *id)

void	BKE_id_newptr_and_tag_clear (ID *id)

void	BKE_lib_id_make_local_generic_action_define (Main bmain, ID id, int flags, bool r_force_local, bool r_force_copy)

void	BKE_lib_id_make_local_generic (Main bmain, ID id, int flags)

bool	BKE_lib_id_make_local (Main bmain, ID id, int flags)

bool	id_single_user (bContext C, ID id, PointerRNA ptr, PropertyRNA prop)

bool	BKE_id_copy_is_allowed (const ID *id)

ID *	BKE_id_copy_ex (Main bmain, const ID id, ID **new_id_p, int flag)

struct ID *	BKE_id_copy_in_lib (Main bmain, std::optional< Library > owner_library, const ID id, const ID new_owner_id, ID **new_id_p, int flag)

ID *	BKE_id_copy (Main bmain, const ID id)

ID *	BKE_id_copy_for_duplicate (Main bmain, ID id, eDupli_ID_Flags duplicate_flags, int copy_flags)

ID *	BKE_id_copy_for_use_in_bmain (Main bmain, const ID id)

void	BKE_lib_id_swap (Main bmain, ID id_a, ID *id_b, const bool do_self_remap, const int self_remap_flags)

void	BKE_lib_id_swap_full (Main bmain, ID id_a, ID *id_b, const bool do_self_remap, const int self_remap_flags)

void	id_sort_by_name (ListBase lb, ID id, ID *id_sorting_hint)

void	BKE_lib_id_expand_local (Main bmain, ID id, int flags)

IDNewNameResult	BKE_id_new_name_validate (Main &bmain, ListBase &lb, ID &id, const char *newname, IDNewNameMode mode, bool do_linked_data)

void	BKE_lib_id_clear_library_data (Main bmain, ID id, int flags)

void	BKE_main_id_tag_idcode (Main *mainvar, short type, int tag, bool value)

void	BKE_main_id_tag_listbase (ListBase *lb, int tag, bool value)

void	BKE_main_id_tag_all (Main *mainvar, int tag, bool value)

void	BKE_main_id_flag_listbase (ListBase *lb, int flag, bool value)

void	BKE_main_id_flag_all (Main *bmain, int flag, bool value)

void	BKE_main_id_newptr_and_tag_clear (Main *bmain)

void	BKE_main_id_refcount_recompute (Main *bmain, bool do_linked_only)

void	BKE_main_lib_objects_recalc_all (Main *bmain)

void	BKE_main_id_repair_duplicate_names_listbase (Main bmain, ListBase lb)

void	BKE_id_full_name_get (char name[MAX_ID_FULL_NAME], const ID *id, char separator_char)

void	BKE_id_full_name_ui_prefix_get (char name[MAX_ID_FULL_NAME_UI], const ID id, bool add_lib_hint, char separator_char, int r_prefix_len)

const char *	BKE_id_name (const ID &id)

char *	BKE_id_name (ID &id)

char *	BKE_id_to_unique_string_key (const ID *id)

void	BKE_library_make_local (Main bmain, const Library lib, GHash *old_to_new_ids, bool untagged_only, bool set_fake, bool clear_asset_data)

void	BKE_id_tag_set_atomic (ID *id, int tag)

void	BKE_id_tag_clear_atomic (ID *id, int tag)

bool	BKE_id_is_in_main (Main bmain, ID id)

bool	BKE_id_is_in_global_main (ID *id)

bool	BKE_id_can_be_asset (const ID *id)

ID *	BKE_id_owner_get (ID *id, const bool debug_relationship_assert=true)

bool	BKE_id_is_editable (const Main bmain, const ID id)

bool	BKE_id_can_use_id (const ID &id_from, const ID &id_to)

blender::Vector< ID * >	BKE_id_ordered_list (const ListBase *lb)

void	BKE_id_reorder (const ListBase lb, ID id, ID *relative, bool after)

void	BKE_id_blend_write (BlendWriter writer, ID id)

void	BKE_id_eval_properties_copy (ID id_cow, ID id)

Detailed Description

API to manage data-blocks inside of Blender's Main data-base, or as independent runtime-only data.

Note: BKE_lib_ files are for operations over data-blocks themselves, although they might alter Main as well (when creating/renaming/deleting an ID e.g.).

Names

Warning: Descriptions below is ideal goal, current status of naming does not yet fully follow it (this is WIP).

BKE_lib_id_ should be used for rather high-level operations, that involve Main database and relations with other IDs, and can be considered as 'safe' (as in, in themselves, they leave affected IDs/Main in a consistent status).
BKE_lib_libblock_ should be used for lower level operations, that perform some parts of BKE_lib_id_ ones, but will generally not ensure caller that affected data is in a consistent state by their own execution alone.
BKE_lib_main_ should be used for operations performed over all IDs of a given Main data-base.

Note: External code should typically not use BKE_lib_libblock_ functions, except in some specific cases requiring advanced (and potentially dangerous) handling.

Definition in file BKE_lib_id.hh.

Macro Definition Documentation

◆ IS_TAGGED

#define IS_TAGGED ( _id ) ((_id) && (((ID *)_id)->tag & ID_TAG_DOIT))

Definition at line 873 of file BKE_lib_id.hh.

Referenced by blender::ed::object::object_convert_exec().

◆ MAIN_ID_SESSION_UID_UNSET

#define MAIN_ID_SESSION_UID_UNSET 0

When an ID's UID is of that value, it is unset/invalid (e.g. for runtime IDs, etc.).

Definition at line 103 of file BKE_lib_id.hh.

Referenced by blender::deg::DepsgraphNodeBuilder::add_id_node(), BKE_lib_libblock_session_uid_ensure(), BKE_lib_libblock_session_uid_renew(), BKE_main_idmap_create(), BKE_main_idmap_insert_id(), BKE_main_idmap_remove_id(), BLO_memfile_write_init(), direct_link_id_common(), direct_link_region(), main_relations_create_idlink_cb(), blender::ed::object::make_override_library_exec(), blender::ed::object::make_override_library_invoke(), mywrite_id_end(), and blender::ed::object::OBJECT_OT_make_override_library().

◆ MAX_ID_FULL_NAME

#define MAX_ID_FULL_NAME (64 + 64 + 3 + 1) /* 64 is MAX_ID_NAME - 2 */

Definition at line 753 of file BKE_lib_id.hh.

Referenced by BKE_id_full_name_get(), blender::render::hydra::FinalEngine::render(), rna_def_ID(), and SEQ_effect_text_font_load().

◆ MAX_ID_FULL_NAME_UI

#define MAX_ID_FULL_NAME_UI (MAX_ID_FULL_NAME + 3) /* Adds 'keycode' two letters at beginning. */

Definition at line 754 of file BKE_lib_id.hh.

Referenced by id_search_add(), and ui_rna_collection_search_update_fn().

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

New ID creation/copying options.

Enumerator
LIB_ID_CREATE_NO_MAIN	Create data-block outside of any main database - similar to 'localize' functions of materials etc.
LIB_ID_CREATE_NO_USER_REFCOUNT	Do not affect user reference-count of data-blocks used by new one (which also gets zero user-count then). Implies LIB_ID_CREATE_NO_MAIN.
LIB_ID_CREATE_NO_ALLOCATE	Assume given 'newid' already points to allocated memory for whole data-block (ID + data) - USE WITH CAUTION! Implies LIB_ID_CREATE_NO_MAIN.
LIB_ID_CREATE_NO_DEG_TAG	Do not tag new ID for update in depsgraph.
LIB_ID_CREATE_LOCAL	Very similar to LIB_ID_CREATE_NO_MAIN, and should never be used with it (typically combined with LIB_ID_CREATE_LOCALIZE or LIB_ID_COPY_LOCALIZE in fact). It ensures that IDs created with it will get the ID_TAG_LOCALIZED tag, and uses some specific code in some copy cases (mostly for node trees).
LIB_ID_COPY_SET_COPIED_ON_WRITE	Create for the depsgraph, when set ID_TAG_COPIED_ON_EVAL must be set. Internally this is used to share some pointers instead of duplicating them.
LIB_ID_COPY_NO_PREVIEW	Object only, needed by make_local code. Do not copy preview data, when supported.
LIB_ID_COPY_CACHES	Copy runtime data caches.
LIB_ID_COPY_NO_ANIMDATA	Don't copy `id->adt`, used by ID data-block localization routines.
LIB_ID_COPY_NO_LIB_OVERRIDE	Do not copy id->override_library, used by ID data-block override routines.
LIB_ID_COPY_NO_LIB_OVERRIDE_LOCAL_DATA_FLAG	When copying local sub-data (like constraints or modifiers), do not set their "library override local data" flag.
LIB_ID_COPY_ACTIONS	EXCEPTION! Deep-copy actions used by animation-data of copied ID.
LIB_ID_COPY_SHAPEKEY	EXCEPTION! Deep-copy shape-keys used by copied obdata ID.
LIB_ID_COPY_NODETREE_LOCALIZE	EXCEPTION! Specific deep-copy of node trees used e.g. for rendering purposes.
LIB_ID_COPY_RIGID_BODY_NO_COLLECTION_HANDLING	EXCEPTION! Specific handling of RB objects regarding collections differs depending whether we duplicate scene/collections, or objects.
LIB_ID_COPY_ASSET_METADATA
LIB_ID_COPY_DEFAULT	Shape-keys are not real ID's, more like local data to geometry IDs.
LIB_ID_CREATE_LOCALIZE	Create a local, outside of bmain, data-block to work on.
LIB_ID_COPY_LOCALIZE	Generate a local copy, outside of bmain, to work on (used by copy-on-eval e.g.).

Definition at line 154 of file BKE_lib_id.hh.

◆ anonymous enum

anonymous enum

New freeing logic options.

Enumerator
LIB_ID_FREE_NO_MAIN	Do not try to remove freed ID from given Main (passed Main may be NULL).
LIB_ID_FREE_NO_USER_REFCOUNT	Do not affect user reference-count of data-blocks used by freed one. Implies LIB_ID_FREE_NO_MAIN.
LIB_ID_FREE_NOT_ALLOCATED	Assume freed ID data-block memory is managed elsewhere, do not free it (still calls relevant ID type's freeing function though) - USE WITH CAUTION! Implies LIB_ID_FREE_NO_MAIN.
LIB_ID_FREE_NO_DEG_TAG	Do not tag freed ID for update in depsgraph.
LIB_ID_FREE_NO_UI_USER	Do not attempt to remove freed ID from UI data/notifiers/...
LIB_ID_FREE_NO_NAMEMAP_REMOVE	Do not remove freed ID's name from a potential runtime name-map.

Definition at line 374 of file BKE_lib_id.hh.

◆ anonymous enum

anonymous enum

Flags to control make local code behavior.

Enumerator
LIB_ID_MAKELOCAL_FULL_LIBRARY	Making that ID local is part of making local a whole library. Implies LIB_ID_MAKELOCAL_INDIRECT.
LIB_ID_MAKELOCAL_INDIRECT	Also make local indirectly linked IDs. Implied by LIB_ID_MAKELOCAL_FULL_LIBRARY.
LIB_ID_MAKELOCAL_FORCE_LOCAL	In case caller code already knows this ID should be made local without copying.
LIB_ID_MAKELOCAL_FORCE_COPY	In case caller code already knows this ID should be made local using copying.
LIB_ID_MAKELOCAL_ASSET_DATA_CLEAR	Clear asset data (in case the ID can actually be made local, in copy case asset data is never copied over).
LIB_ID_MAKELOCAL_LIBOVERRIDE_CLEAR	Clear any liboverride data as part of making this linked data local.

Definition at line 516 of file BKE_lib_id.hh.

◆ eLibIDDuplicateFlags

enum eLibIDDuplicateFlags

Duplicate (a.k.a. deep copy) common processing options. See also eDupli_ID_Flags for options controlling what kind of IDs to duplicate.

Enumerator
LIB_ID_DUPLICATE_IS_SUBPROCESS	This call to a duplicate function is part of another call for some parent ID. Therefore, this sub-process should not clear `newid` pointers, nor handle remapping itself. NOTE: In some cases (like Object one), the duplicate function may be called on the root ID with this flag set, as remapping and/or other similar tasks need to be handled by the caller.
LIB_ID_DUPLICATE_IS_ROOT_ID	This call is performed on a 'root' ID, and should therefore perform some decisions regarding sub-IDs (dependencies), check for linked vs. locale data, etc.

Definition at line 356 of file BKE_lib_id.hh.

◆ IDNewNameMode

enum class IDNewNameMode

strong

How to handle ID rename in case requested name is already used by another ID.

Enumerator

RenameExistingNever

Never rename another existing ID if the target name is already in use. The renamed ID will get a name modified with a numerical suffix instead.

RenameExistingAlways

Always rename another existing ID if the target name is already in use. The renamed ID will get the requested unmodified name.

RenameExistingSameRoot

Only rename another existing ID if the target name is already in use, when the current name of the renamed ID has the same root as the other ID name (i.e. they have the same name, besides the numeric suffix). E.g. Assuming there is already an existing ID named Object:

Renaming Object.001 to Object: rename to Object, the existing Object ID is renamed to e.g. Object.001
Renaming Cube to Object: rename to Object.001, the existing Object ID is not renamed.

Definition at line 261 of file BKE_lib_id.hh.

Function Documentation

◆ BKE_id_blend_write()

void BKE_id_blend_write	(	BlendWriter *	writer,
		ID *	id )

Definition at line 2560 of file lib_id.cc.

References BKE_animdata_blend_write(), BKE_asset_metadata_write(), BLO_write_string(), BLO_write_struct, BLO_write_struct_list, ELEM, GS, ID_WM, IDP_BlendWrite(), and LISTBASE_FOREACH.

Referenced by blender::bke::action_blend_write(), armature_blend_write(), BKE_collection_blend_write_nolib(), brush_blend_write(), cache_file_blend_write(), camera_blend_write(), curve_blend_write(), curves_blend_write(), grease_pencil_blend_write(), greasepencil_blend_write(), image_blend_write(), lattice_blend_write(), light_blend_write(), lightprobe_blend_write(), linestyle_blend_write(), mask_blend_write(), material_blend_write(), mesh_blend_write(), metaball_blend_write(), movieclip_blend_write(), blender::bke::node_tree_blend_write(), object_blend_write(), paint_curve_blend_write(), palette_blend_write(), particle_settings_blend_write(), pointcloud_blend_write(), scene_blend_write(), screen_blend_write(), shapekey_blend_write(), sound_blend_write(), speaker_blend_write(), text_blend_write(), texture_blend_write(), vfont_blend_write(), volume_blend_write(), window_manager_blend_write(), workspace_blend_write(), world_blend_write(), and write_libraries().

◆ BKE_id_can_be_asset()

bool BKE_id_can_be_asset ( const ID * id )

Definition at line 2438 of file lib_id.cc.

References BKE_idtype_idcode_is_linkable(), GS, ID_IS_EDITABLE, and ID_IS_OVERRIDE_LIBRARY.

Referenced by blender::ed::asset::copy_to_id(), blender::ed::asset::id_type_is_supported(), and blender::ed::asset::mark_id().

◆ BKE_id_can_use_id()

bool BKE_id_can_use_id	(	const ID &	id_from,
		const ID &	id_to )

Check that a pointer from one ID to another is possible.

Taking into account lib linking and main database membership.

Definition at line 2461 of file lib_id.cc.

References ID_TAG_NO_MAIN, ID::lib, and ID::tag.

Referenced by RNA_property_pointer_poll().

◆ BKE_id_copy()

ID * BKE_id_copy	(	Main *	bmain,
		const ID *	id )

Invoke the appropriate copy method for the block and return the new id as result.

See BKE_id_copy_ex for details.

Definition at line 765 of file lib_id.cc.

References BKE_id_copy_in_lib(), and LIB_ID_COPY_DEFAULT.

Referenced by action_create_new(), animdata_copy_id_action(), BCAnimation::BCAnimation(), BKE_animdata_merge_copy(), BKE_gpencil_data_duplicate(), BKE_id_copy_for_use_in_bmain(), BKE_lib_override_library_operations_store_start(), BKE_scene_duplicate(), brush_make_local(), copy_particle_systems_to_object(), DocumentImporter::create_instance_node(), blender::ed::object::duplibase_for_convert(), ED_mesh_join_objects_exec(), geometry_extract_apply(), blender::ed::object::make_object_duplilist_real(), new_texture_exec(), nlaedit_apply_scale_exec(), nlaedit_make_single_user_exec(), blender::ed::space_node::node_group_ungroup(), blender::ed::object::object_convert_exec(), paint_mask_slice_exec(), and separate_exec().

◆ BKE_id_copy_ex()

ID * BKE_id_copy_ex	(	Main *	bmain,
		const ID *	id,
		ID **	new_id_p,
		int	flag )

Generic entry point for copying a data-block (new API).

Note: Copy is generally only affecting the given data-block (no ID used by copied one will be affected, besides user-count).

There are exceptions though:

Embedded IDs (root node trees and master collections) are always copied with their owner.
If LIB_ID_COPY_ACTIONS is defined, actions used by anim-data will be duplicated.
If LIB_ID_COPY_SHAPEKEY is defined, shape-keys will be duplicated.
If LIB_ID_CREATE_LOCAL is defined, root node trees will be deep-duplicated recursively.

Note: User-count of new copy is always set to 1.; Typically, the newly copied ID will be a local data (its lib pointer will be nullptr). In practice, ID copying follows the same behavior as ID creation (see BKE_libblock_alloc documentation), with one special case: when the special flag LIB_ID_CREATE_NO_ALLOCATE is specified, the copied ID will have the same library as the source ID.

Parameters

bmain	Main database, may be NULL only if LIB_ID_CREATE_NO_MAIN is specified.
id	Source data-block.
new_id_p	Pointer to new (copied) ID pointer, may be NULL. Used to allow copying into already allocated memory.
flag	Set of copy options, see `DNA_ID.h` enum for details (leave to zero for default, full copy).

Returns: NULL when copying that ID type is not supported, the new copy otherwise.

Definition at line 760 of file lib_id.cc.

References BKE_id_copy_in_lib(), and flag.

Referenced by blender::ed::object::apply_grease_pencil_for_modifier(), blender::ed::object::apply_grease_pencil_for_modifier_all_keyframes(), blender::bke::asset_main_create_from_ID(), BKE_curves_copy_for_eval(), BKE_displist_make_curveTypes(), BKE_grease_pencil_copy_for_eval(), BKE_id_copy_for_duplicate(), BKE_lattice_modifiers_calc(), BKE_lib_id_make_local_generic(), BKE_lib_override_library_update(), BKE_mesh_copy_for_eval(), BKE_nlastrip_copy(), BKE_pointcloud_copy_for_eval(), BKE_volume_copy_for_eval(), clip_start_prefetch_job(), blender::ed::object::create_applied_mesh_for_modifier(), curve_from_curve_object(), curve_from_font_object(), do_hair_dynamics(), duplicate_ids(), blender::ed::space_node::duplicate_material(), flip_pose(), blender::ed::object::geometry_node_tree_copy_assign_exec(), blender::realtime_compositor::get_mask_raster_handles(), get_quick_mesh(), id_single_user(), blender::compositor::MaskOperation::init_execution(), mesh_new_from_mesh(), modify_mesh(), modify_mesh(), modify_mesh(), new_material_exec(), new_particle_settings_exec(), new_world_exec(), blender::bke::node_tree_copy_tree_ex(), normalEditModifier_do(), object_for_curve_to_mesh_create(), particle_settings_localize(), preview_get_localized_world(), psys_thread_context_init_distribute(), remap_hair_emitter(), seq_render_mask(), blender::ed::object::single_mat_users(), blender::ed::object::single_obdata_users(), blender::ed::object::single_object_users_collection(), and undomesh_from_editmesh().

◆ BKE_id_copy_for_duplicate()

ID * BKE_id_copy_for_duplicate	(	Main *	bmain,
		ID *	id,
		eDupli_ID_Flags	duplicate_flags,
		int	copy_flags )

Invoke the appropriate copy method for the block and return the new id as result.

Unlike BKE_id_copy, it does set the ID.newid pointer of the given id to the copied one.

It is designed as a basic common helper for the higher-level 'duplicate' operations (aka 'deep copy' of data-blocks and some of their dependency ones), see e.g. BKE_object_duplicate.

Currently, it only handles the given ID, and their shape keys and actions if any, according to the given duplicate_flags.

Parameters

duplicate_flags	is of type eDupli_ID_Flags, see UserDef.dupflag. Currently only `USER_DUP_LINKED_ID` and `USER_DUP_ACT` have an effect here.
copy_flags	flags passed to BKE_id_copy_ex.

Definition at line 770 of file lib_id.cc.

References BKE_animdata_duplicate_id_action(), BKE_id_copy_ex(), BKE_key_from_id(), ID_IS_LINKED, ID_NEW_SET, id_us_min(), and USER_DUP_LINKED_ID.

Referenced by BKE_object_duplicate(), BKE_scene_duplicate(), and collection_duplicate_recursive().

◆ BKE_id_copy_for_use_in_bmain()

ID * BKE_id_copy_for_use_in_bmain	(	Main *	bmain,
		const ID *	id )

Special version of BKE_id_copy which is safe from using evaluated id as source with a copy result appearing in the main database. Takes care of the referenced data-blocks consistency.

Definition at line 834 of file lib_id.cc.

References BKE_id_copy(), BKE_key_from_id_p(), BKE_library_foreach_ID_link(), DEG_is_evaluated_id(), foreach_assign_id_to_orig_callback(), and IDWALK_NOP.

◆ BKE_id_copy_in_lib()

struct ID * BKE_id_copy_in_lib	(	Main *	bmain,
		std::optional< Library * >	owner_library,
		const ID *	id,
		const ID *	new_owner_id,
		ID **	new_id_p,
		int	flag )

Enable copying non-local data into libraries.

See BKE_id_copy_ex for details.

Parameters

owner_library	the Library to 'assign' the newly created ID to. Use `nullptr` to make ID not use any library (i.e. become a local ID). Use #std::nullopt for default behavior (i.e. behavior of the BKE_id_copy_ex function).
new_owner_id	When copying an embedded ID, the owner ID of the new copy. Should be `nullptr` for regular ID copying, or in case the owner ID is not (yet) known.

Definition at line 656 of file lib_id.cc.

References BKE_idtype_get_info_from_id(), BKE_libblock_copy_in_lib(), BKE_libblock_get_alloc_info(), BKE_library_foreach_ID_link(), BLI_assert, BLI_assert_msg, IDTypeInfo::copy_data, flag, ID::flag, IDTypeInfo::flags, GS, id_copy_libmanagement_cb(), ID_FLAG_EMBEDDED_DATA, ID_IS_LINKED, IDCopyLibManagementData::id_src, ID_TAG_EXTERN, ID_TAG_INDIRECT, IDTYPE_FLAGS_NO_COPY, IDWALK_IGNORE_MISSING_OWNER_ID, ID::lib, lib_id_copy_ensure_local(), LIB_ID_CREATE_NO_ALLOCATE, LIB_ID_CREATE_NO_MAIN, lib_id_library_local_paths(), and ID::tag.

Referenced by BKE_animdata_copy_in_lib(), BKE_id_copy(), BKE_id_copy_ex(), curve_copy_data(), lattice_copy_data(), blender::bke::greasepencil::convert::legacy_gpencil_sanitize_annotations(), lib_override_library_create_from(), light_copy_data(), linestyle_copy_data(), material_copy_data(), mesh_copy_data(), blender::bke::node_tree_localize(), scene_copy_data(), texture_copy_data(), and world_copy_data().

◆ BKE_id_copy_is_allowed()

bool BKE_id_copy_is_allowed ( const ID * id )

Test whether given id can be copied or not.

Definition at line 647 of file lib_id.cc.

References ELEM, GS, ID_TYPE_IS_DEPRECATED, and LIB_ID_TYPES_NOCOPY.

Referenced by template_ID().

◆ BKE_id_delete()

void BKE_id_delete	(	Main *	bmain,
		void *	idv )

Properly delete a single ID from given bmain database.

Definition at line 369 of file lib_id_delete.cc.

References BKE_id_delete_ex().

Referenced by blender::bke::asset_edit_id_delete(), blender::bke::asset_reload(), BKE_blendfile_library_relocate(), BKE_blendfile_read_make_empty(), BKE_brush_delete(), BKE_collection_delete(), BKE_lib_override_library_create_from_tag(), blo_read_file_internal(), BLO_update_defaults_startup_blend(), blender::ed::object::clear_override_library_exec(), blender::ed::object::collection_unlink_exec(), ED_scene_delete(), blender::bke::blendfile::PartialWriteContext::id_delete(), blender::ed::outliner::id_override_library_clear_single_process(), Freestyle::PythonInterpreter::interpretFile(), blender::ed::outliner::outliner_object_delete_fn(), override_idtemplate_clear_exec(), sequencer_clipboard_paste_exec(), text_unlink_exec(), blender::ed::object::volume_import_exec(), blender::bke::blendfile::PartialWriteContext::write(), and BCAnimation::~BCAnimation().

◆ BKE_id_delete_ex()

void BKE_id_delete_ex	(	Main *	bmain,
		void *	idv,
		const int	extra_remapping_flags )

Like BKE_id_delete, but with extra corner-case options.

Parameters

extra_remapping_flags Additional ID_REMAP_ flags to pass to remapping code when ensuring that deleted IDs are not used by any other ID in given bmain. Typical example would be e.g. ID_REMAP_FORCE_UI_POINTERS, required when default UI-handling callbacks of remapping code won't be working (e.g. from readfile code).

Referenced by BLO_main_validate_shapekeys().

◆ BKE_id_eval_properties_copy()

void BKE_id_eval_properties_copy	(	ID *	id_cow,
		ID *	id )

Copy relatives parameters, from id to id_cow. Use handle the ID_RECALC_PARAMETERS tag.

Note: Keep in sync with ID_TYPE_SUPPORTS_PARAMS_WITHOUT_COW.

Definition at line 20 of file lib_id_eval.cc.

References BKE_mesh_copy_parameters(), BLI_assert, BLI_assert_unreachable, GS, ID_ME, ID_TAG_COPIED_ON_EVAL, ID_TYPE_SUPPORTS_PARAMS_WITHOUT_COW, and ID::tag.

Referenced by blender::deg::DepsgraphNodeBuilder::build_parameters().

◆ BKE_id_free()

void BKE_id_free	(	Main *	bmain,
		void *	idv )

Complete ID freeing, should be usable in most cases (even for out-of-Main IDs).

See BKE_id_free_ex description for full details.

Parameters

bmain	Main database containing the freed ID, can be NULL in case it's a temp ID outside of any Main.
idv	Pointer to ID to be freed.

Definition at line 201 of file lib_id_delete.cc.

References BKE_id_free_ex().

◆ BKE_id_free_ex()

void BKE_id_free_ex	(	Main *	bmain,
		void *	idv,
		int	flag_orig,
		bool	use_flag_from_idtag )

Complete ID freeing, extended version for corner cases. Can override default (and safe!) freeing process, to gain some speed up.

At that point, given id is assumed to not be used by any other data-block already (might not be actually true, in case e.g. several inter-related IDs get freed together...). However, they might still be using (referencing) other IDs, this code takes care of it if ID_TAG_NO_USER_REFCOUNT is not defined.

Parameters

bmain	Main database containing the freed ID, can be NULL in case it's a temp ID outside of any Main.
idv	Pointer to ID to be freed.
flag_orig	Set of LIB_ID_FREE_... flags controlling/overriding usual freeing process, 0 to get default safe behavior.
use_flag_from_idtag	Still use freeing info flags from given ID data-block, even if some overriding ones are passed in flag parameter.

Definition at line 175 of file lib_id_delete.cc.

References BKE_layer_collection_resync_allow(), BKE_layer_collection_resync_forbid(), BKE_main_collection_sync_remap(), ELEM, GS, id_free(), ID_GR, ID_OB, ID_SCE, and LIB_ID_FREE_NO_MAIN.

Referenced by BKE_id_free(), BKE_lib_override_library_operations_store_finalize(), BKE_lib_override_library_operations_store_start(), BKE_lib_override_library_update(), BKE_main_clear(), and ED_mesh_join_objects_exec().

◆ BKE_id_free_us()

void BKE_id_free_us	(	Main *	bmain,
		void *	idv )

Not really a freeing function by itself, it decrements user-count of given id, and only frees it if it reaches 0.

Definition at line 206 of file lib_id_delete.cc.

References BKE_id_free(), BKE_libblock_unlink(), BKE_library_main_rebuild_hierarchy(), GS, ID_IS_LINKED, ID_LI, ID_OB, id_us_clear_real(), and id_us_min().

Referenced by blender::ed::space_node::add_node_group_asset(), animchannels_delete_exec(), BKE_object_shapekey_free(), collection_object_remove_no_gobject_hash(), DocumentImporter::create_camera_object(), DocumentImporter::create_light_object(), MeshImporter::create_mesh_object(), ED_workspace_delete(), gpencil_layer_remove_exec(), blender::io::usd::import_endjob(), import_endjob(), and WM_drag_free_imported_drag_ID().

◆ BKE_id_full_name_get()

void BKE_id_full_name_get	(	char	name[MAX_ID_FULL_NAME],
		const ID *	id,
		char	separator_char )

Generate full name of the data-block (without ID code, but with library if any).

Note: Result is unique to a given ID type in a given Main database.

Parameters

name	An allocated string of minimal length MAX_ID_FULL_NAME, will be filled with generated string.
separator_char	Character to use for separating name and library name. Can be 0 to use default (' ').

Definition at line 2365 of file lib_id.cc.

References BKE_id_name(), BLI_strncpy(), ID_IS_LINKED, and MAX_ID_FULL_NAME.

Referenced by BKE_id_full_name_ui_prefix_get(), blender::render::hydra::FinalEngine::render(), and SEQ_effect_text_font_load().

◆ BKE_id_full_name_ui_prefix_get()

void BKE_id_full_name_ui_prefix_get	(	char	name[MAX_ID_FULL_NAME_UI],
		const ID *	id,
		bool	add_lib_hint,
		char	separator_char,
		int *	r_prefix_len )

Generate full name of the data-block (without ID code, but with library if any), with a 2 to 3 character prefix prepended indicating whether it comes from a library, is overriding, has a fake or no user, etc.

Note: Result is unique to a given ID type in a given Main database.

Parameters

name	An allocated string of minimal length MAX_ID_FULL_NAME_UI, will be filled with generated string.
separator_char	Character to use for separating name and library name. Can be 0 to use default (' ').
r_prefix_len	The length of the prefix added.

Definition at line 2382 of file lib_id.cc.

References BKE_id_full_name_get(), ID_FLAG_FAKEUSER, ID_IS_OVERRIDE_LIBRARY, and ID_MISSING.

Referenced by add_collection_search_item(), id_search_add(), and ui_rna_collection_search_update_fn().

◆ BKE_id_is_editable()

bool BKE_id_is_editable	(	const Main *	bmain,
		const ID *	id )

Check if that ID can be considered as editable from a high-level (editor) perspective.

Note: Unlike the ID_IS_EDITABLE macro, this also take into account higher-level aspects, e.g. it checks if the given ID is a system overrides (which should not be editable from the UI).

Definition at line 2456 of file lib_id.cc.

References BKE_lib_override_library_is_system_defined(), and ID_IS_EDITABLE.

◆ BKE_id_is_in_global_main()

bool BKE_id_is_in_global_main ( ID * id )

Check that given ID pointer actually is in G_MAIN. Main intended use is for debug asserts in places we cannot easily get rid of G_MAIN.

Definition at line 2433 of file lib_id.cc.

References BKE_id_is_in_main(), and G_MAIN.

Referenced by bpy_bmesh_to_mesh(), pygpu_offscreen_draw_view3d(), and pyrna_struct_keyframe_insert().

◆ BKE_id_is_in_main()

bool BKE_id_is_in_main	(	Main *	bmain,
		ID *	id )

Check that given ID pointer actually is in given bmain.

Definition at line 2426 of file lib_id.cc.

References BLI_findindex(), GS, and which_libbase().

Referenced by BKE_id_is_in_global_main(), and BKE_libblock_rename().

◆ BKE_id_move_to_same_lib()

void BKE_id_move_to_same_lib	(	Main &	bmain,
		ID &	id,
		const ID &	owner_id )

For newly created IDs, move it into same library as owner ID. This assumes the ID is local.

Definition at line 862 of file lib_id.cc.

References BKE_id_name(), BKE_id_new_name_validate(), BKE_main_namemap_remove_name(), BLI_assert_msg, GS, ID_IS_LINKED, ID_TAG_INDIRECT, ID::lib, RenameExistingNever, and which_libbase().

Referenced by image_new_exec(), image_open_exec(), new_material_exec(), blender::ed::space_node::new_node_tree_exec(), new_texture_exec(), new_world_exec(), blender::ed::space_node::node_group_make_from_nodes(), and paintcurve_for_brush_add().

◆ BKE_id_multi_delete()

size_t BKE_id_multi_delete	(	Main *	bmain,
		blender::Set< ID * > &	ids_to_delete )

Properly delete all IDs from ids_to_delete, from given bmain database.

This is more efficient than calling BKE_id_delete repetitively on a large set of IDs (several times faster when deleting most of the IDs at once).

Note: The ID pointers are not removed from the Set (which may contain more pointers than originally given, when extra users or dependencies also had to be deleted with the original set of IDs). They are all freed though, so these pointers are all invalid after calling this function.

Returns: Number of deleted data-blocks.

Definition at line 387 of file lib_id_delete.cc.

References id_delete().

◆ BKE_id_multi_tagged_delete()

void size_t BKE_id_multi_tagged_delete ( Main * bmain )

Properly delete all IDs tagged with ID_TAG_DOIT, in given bmain database.

This is more efficient than calling BKE_id_delete repetitively on a large set of IDs (several times faster when deleting most of the IDs at once).

Returns: Number of deleted data-blocks.

Definition at line 374 of file lib_id_delete.cc.

References blender::Set< Key, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add(), FOREACH_MAIN_ID_BEGIN, FOREACH_MAIN_ID_END, id_delete(), ID_TAG_DOIT, and ID::tag.

Referenced by BKE_blendfile_append(), BKE_blendfile_library_relocate(), BKE_lib_override_library_delete(), bpy_batch_remove(), bpy_orphans_purge(), lib_override_cleanup_after_resync(), lib_override_library_main_resync_on_library_indirect_level(), lib_override_library_resync(), blender::ed::object::object_delete_exec(), blender::ed::outliner::outliner_batch_delete_object_hierarchy(), blender::ed::outliner::outliner_id_delete_invoke(), blender::ed::outliner::outliner_id_operation_exec(), blender::ed::outliner::outliner_lib_operation_exec(), blender::ed::outliner::outliner_orphans_purge_exec(), and blender::bke::blendfile::PartialWriteContext::remove_unused().

◆ BKE_id_name() [1/2]

const char * BKE_id_name ( const ID & id )

inline

Get the name (without type prefix) of the ID.

Definition at line 788 of file BKE_lib_id.hh.

Referenced by blender::bke::asset_reload(), BKE_blendfile_library_relocate(), BKE_id_full_name_get(), BKE_id_move_to_same_lib(), BKE_id_new_name_validate(), BKE_id_to_unique_string_key(), BKE_lib_id_clear_library_data(), BKE_libblock_copy_in_lib(), BKE_libblock_find_name_and_library(), BKE_libblock_find_name_and_library_filepath(), BKE_libblock_management_main_remove(), BKE_libblock_rename(), BKE_main_id_repair_duplicate_names_listbase(), foreach_libblock_append_add_dependencies_callback(), and foreach_libblock_link_finalize_cb().

◆ BKE_id_name() [2/2]

char * BKE_id_name ( ID & id )

inline

Definition at line 792 of file BKE_lib_id.hh.

◆ BKE_id_new()

void * BKE_id_new	(	Main *	bmain,
		short	type,
		const char *	name )

Generic helper to create a new empty data-block of given type in given bmain database.

Note: By default, IDs created in a Main database will get the current library of the Main, i.e. usually (besides in readfile case), they will have a nullptr lib pointer and be local data. IDs created outside of a Main database will always get a nullptr lib pointer.

Parameters

name	can be NULL, in which case we get default name for this ID type.

Definition at line 1482 of file lib_id.cc.

References BKE_id_new_in_lib().

◆ BKE_id_new_in_lib()

void * BKE_id_new_in_lib	(	Main *	bmain,
		std::optional< Library * >	owner_library,
		short	type,
		const char *	name )

Same as for BKE_id_new, but allows creating a data-block for (within) a given owner library.

Parameters

owner_library the Library to 'assign' the newly created ID to. Use nullptr to make ID not use any library (i.e. become a local ID). Use std::nullopt for default behavior (i.e. behavior of the BKE_id_new function).

Definition at line 1464 of file lib_id.cc.

References BKE_idtype_idcode_to_name(), BKE_libblock_alloc_in_lib(), BKE_libblock_init_empty(), BLI_assert, and DATA_.

Referenced by BKE_id_new(), blender::bke::blendfile::PartialWriteContext::id_create(), blender::bke::greasepencil::convert::legacy_gpencil_object(), and blender::bke::greasepencil::convert::legacy_main().

◆ BKE_id_new_name_validate()

IDNewNameResult BKE_id_new_name_validate	(	Main &	bmain,
		ListBase &	lb,
		ID &	id,
		const char *	newname,
		IDNewNameMode	mode,
		bool	do_linked_data )

Optionally set the given ID's name from given parameter, and ensure that the ID has a unique name in given listbase.

Uniqueness is only ensured within the ID's library (nullptr for local ones), libraries act as some kind of namespace for IDs.

Parameters

newname	The new name of the given ID, if `nullptr` the current given ID name is used instead. If the given ID has no name (or the given name is an empty string), the default matching data name is used as fallback.
do_linked_data	if true, also ensure a unique name in case the given ID is linked (otherwise, just ensure that it is properly sorted).

Returns: How renaming went on, see IDNewNameResult for details.

Definition at line 1850 of file lib_id.cc.

References BKE_id_name(), BKE_idtype_idcode_to_name(), BKE_libblock_find_name(), BKE_main_namemap_get_name(), BLI_assert, BLI_str_utf8_invalid_strip(), BLI_string_split_name_number(), BLI_strncpy(), DATA_, ELEM, GS, ID_IS_LINKED, id_sort_by_name(), lib, MAX_ID_NAME, ID::name, IDNewNameResult::RENAMED_COLLISION_ADJUSTED, IDNewNameResult::RENAMED_COLLISION_FORCED, IDNewNameResult::RENAMED_NO_COLLISION, RenameExistingAlways, RenameExistingSameRoot, result, STREQ, STRNCPY, STRNCPY_UTF8, IDNewNameResult::UNCHANGED, and IDNewNameResult::UNCHANGED_COLLISION.

Referenced by BKE_id_move_to_same_lib(), BKE_lib_id_clear_library_data(), BKE_libblock_alloc_in_lib(), BKE_libblock_management_main_add(), BKE_libblock_rename(), BKE_main_id_repair_duplicate_names_listbase(), main_namemap_validate_and_fix(), reuse_bmain_move_id(), and versions_gpencil_add_main().

◆ BKE_id_new_nomain()

void * BKE_id_new_nomain	(	short	type,
		const char *	name )

Generic helper to create a new temporary empty data-block of given type, outside of any Main database.

Parameters

name	can be NULL, in which case we get default name for this ID type.

Definition at line 1487 of file lib_id.cc.

References BKE_idtype_idcode_to_name(), BKE_libblock_alloc(), BKE_libblock_init_empty(), DATA_, LIB_ID_CREATE_NO_DEG_TAG, LIB_ID_CREATE_NO_MAIN, and LIB_ID_CREATE_NO_USER_REFCOUNT.

Referenced by BKE_grease_pencil_new_nomain(), BKE_mesh_from_bmesh_for_eval_nomain(), BKE_mesh_from_bmesh_nomain(), BKE_mesh_new_nomain_from_template_ex(), BKE_mesh_wrapper_from_editmesh(), BKE_volume_new_for_eval(), blender::io::obj::CurveFromGeometry::create_curve(), blender::nodes::node_geo_mesh_primitive_ico_sphere_cc::create_ico_sphere_mesh(), create_mesh(), blender::bke::curves_new_nomain(), blender::bke::curves_new_nomain(), blender::bke::CurveComponent::get_curve_for_render(), blender::eevee::MaterialModule::MaterialModule(), mesh_new_from_mball_object(), mesh_to_volume(), blender::nodes::node_geo_volume_cube_cc::node_geo_exec(), blender::ed::object::object_convert_exec(), blender::ed::spreadsheet::spreadsheet_get_display_geometry_set(), blender::bke::greasepencil::tests::TEST(), blender::bke::greasepencil::tests::TEST(), blender::bke::greasepencil::tests::TEST(), blender::bke::tests::TEST(), and blender::animrig::tests::TEST_F().

◆ BKE_id_newptr_and_tag_clear()

void BKE_id_newptr_and_tag_clear ( ID * id )

Definition at line 405 of file lib_id.cc.

References BKE_id_newptr_and_tag_clear(), BKE_key_from_id(), GS, bNodeTree::id, Collection::id, Key::id, ID_SCE, and blender::bke::node_tree_from_id().

Referenced by BKE_id_newptr_and_tag_clear(), BKE_main_id_newptr_and_tag_clear(), blender::ed::outliner::id_local_fn(), and template_id_cb().

◆ BKE_id_ordered_list()

blender::Vector< ID * > BKE_id_ordered_list ( const ListBase * lb )

Returns ordered list of data-blocks for display in the UI.

Definition at line 2505 of file lib_id.cc.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append(), blender::Vector< T, InlineBufferCapacity, Allocator >::begin(), blender::Vector< T, InlineBufferCapacity, Allocator >::end(), id_order_compare(), id_order_get(), blender::Vector< T, InlineBufferCapacity, Allocator >::index_range(), and LISTBASE_FOREACH.

Referenced by ED_workspace_delete(), space_workspace_cycle_invoke(), and template_ID_tabs().

◆ BKE_id_owner_get()

ID * BKE_id_owner_get	(	ID *	id,
		const bool	debug_relationship_assert = true )

Return the owner ID of the given id, if any.

Note: This will only return non-NULL for embedded IDs (master collections etc.), and shape-keys.

Parameters

debug_relationship_assert True by default, whether to perform debug checks on validity of the pointers between owner and embedded IDs. In some cases, these relations are not yet (fully) valid, e.g. during ID copying.

Definition at line 2444 of file lib_id.cc.

References BKE_idtype_get_info_from_id(), and IDTypeInfo::owner_pointer_get.

Referenced by BKE_lib_override_library_get(), blender::ed::outliner::collection_duplicate_exec(), blender::animrig::find_related_ids(), blender::animrig::id_action_ensure(), blender::bke::blendfile::PartialWriteContext::id_add(), lib_query_unused_ids_tag_recurse(), libblock_remap_data(), library_foreach_ID_link(), blender::ed::outliner::outliner_collection_delete(), and RNA_find_real_ID_and_path().

◆ BKE_id_rename()

IDNewNameResult BKE_id_rename	(	Main &	bmain,
		ID &	id,
		blender::StringRefNull	name,
		const IDNewNameMode	mode = IDNewNameMode::RenameExistingNever )

Like BKE_libblock_rename, but also performs additional higher-level updates like depsgraph tagging when renaming Meta-ball objects, etc.

Returns: true if the name of the ID was actually modified.

Definition at line 2338 of file lib_id.cc.

References BKE_libblock_rename(), DEG_id_tag_update(), ELEM, GS, Object::id, ID_OB, ID_RECALC_GEOMETRY, OB_MBALL, result, Object::type, IDNewNameResult::UNCHANGED, and IDNewNameResult::UNCHANGED_COLLISION.

Referenced by ED_id_rename().

◆ BKE_id_reorder()

void BKE_id_reorder	(	const ListBase *	lb,
		ID *	id,
		ID *	relative,
		bool	after )

Reorder ID in the list, before or after the "relative" ID.

Definition at line 2524 of file lib_id.cc.

References BLI_listbase_count(), id_order_get(), and LISTBASE_FOREACH.

Referenced by workspace_append_activate_exec(), workspace_reorder_to_back_exec(), and workspace_reorder_to_front_exec().

◆ BKE_id_tag_clear_atomic()

void BKE_id_tag_clear_atomic	(	ID *	id,
		int	tag )

Definition at line 2421 of file lib_id.cc.

References atomic_fetch_and_and_int32().

◆ BKE_id_tag_set_atomic()

void BKE_id_tag_set_atomic	(	ID *	id,
		int	tag )

Definition at line 2416 of file lib_id.cc.

References atomic_fetch_and_or_int32().

◆ BKE_id_to_unique_string_key()

char * BKE_id_to_unique_string_key ( const ID * id )

Generate a concatenation of ID name (including two-chars type code) and its lib name, if any.

Returns: A unique allocated string key for any ID in the whole Main database.

Definition at line 2403 of file lib_id.cc.

References BKE_id_name(), BLI_sprintfN(), BLI_strdup(), and ID_IS_LINKED.

◆ BKE_lib_id_clear_library_data()

void BKE_lib_id_clear_library_data	(	Main *	bmain,
		ID *	id,
		int	flags )

Pull an ID out of a library (make it local). Only call this for IDs that don't have other library users.

Parameters

flags Same set of LIB_ID_MAKELOCAL_ flags as passed to BKE_lib_id_make_local.

Definition at line 206 of file lib_id.cc.

References IDTypeInfo::asset_type_info, BKE_asset_metadata_free(), BKE_id_name(), BKE_id_new_name_validate(), BKE_idtype_get_info_from_id(), BKE_key_from_id(), BKE_lib_id_clear_library_data(), BKE_lib_libblock_session_uid_renew(), BKE_library_foreach_ID_link(), BKE_main_namemap_remove_name(), DEG_id_tag_update_ex(), DEG_relations_tag_update(), ELEM, FOREACH_MAIN_ID_BEGIN, FOREACH_MAIN_ID_END, GS, Key::id, id_fake_user_clear(), id_fake_user_set(), ID_FLAG_EMBEDDED_DATA, ID_IS_ASSET, ID_RECALC_SYNC_TO_EVAL, ID_TAG_EXTERN, ID_TAG_INDIRECT, ID_TAG_NO_MAIN, ID_TAG_TEMP_MAIN, IDWALK_READONLY, Main::is_memfile_undo_written, lib_id_clear_library_data_users_update_cb(), lib_id_library_local_paths(), LIB_ID_MAKELOCAL_ASSET_DATA_CLEAR, AssetTypeInfo::on_clear_asset_fn, RenameExistingNever, IDNewNameResult::UNCHANGED, IDNewNameResult::UNCHANGED_COLLISION, and which_libbase().

Referenced by BKE_lib_id_clear_library_data(), BKE_lib_id_make_local_generic(), BKE_library_make_local(), brush_make_local(), and lib_id_expand_local_cb().

◆ BKE_lib_id_expand_local()

void BKE_lib_id_expand_local	(	Main *	bmain,
		ID *	id,
		int	flags )

Expand ID usages of given id as 'extern' (and no more indirect) linked data. Used by ID copy/make_local functions.

Definition at line 474 of file lib_id.cc.

References BKE_library_foreach_ID_link(), IDWALK_READONLY, lib_id_expand_local_cb(), and POINTER_FROM_INT.

Referenced by BKE_lib_id_make_local_generic(), BKE_library_make_local(), brush_make_local(), and lib_id_copy_ensure_local().

◆ BKE_lib_id_make_local()

bool BKE_lib_id_make_local	(	Main *	bmain,
		ID *	id,
		int	flags )

Calls the appropriate make_local method for the block, unless test is set.

Note: Always set ID.newid pointer in case it gets duplicated.

Parameters

flags Special flag used when making a whole library's content local, it needs specific handling.

Returns: true is the ID has successfully been made local.

Definition at line 584 of file lib_id.cc.

References BKE_idtype_get_info_from_id(), BKE_lib_id_make_local_generic(), BLI_assert, BLI_assert_msg, IDTypeInfo::flags, ID_TAG_INDIRECT, IDTYPE_FLAGS_NO_LIBLINKING, LIB_ID_MAKELOCAL_FULL_LIBRARY, LIB_ID_MAKELOCAL_INDIRECT, and IDTypeInfo::make_local.

Referenced by BKE_blendfile_append(), BKE_library_make_local(), brush_make_local(), blender::ed::outliner::id_local_fn(), and template_id_cb().

◆ BKE_lib_id_make_local_generic()

void BKE_lib_id_make_local_generic	(	Main *	bmain,
		ID *	id,
		int	flags )

Generic 'make local' function, works for most of data-block types.

Definition at line 530 of file lib_id.cc.

References BKE_id_copy_ex(), BKE_key_from_id(), BKE_lib_id_clear_library_data(), BKE_lib_id_expand_local(), BKE_lib_id_make_local_generic_action_define(), BKE_lib_override_library_make_local(), BKE_libblock_remap(), GS, ID_IS_LINKED, ID_NEW_SET, ID_REMAP_SKIP_INDIRECT_USAGE, ID_SCE, LIB_ID_COPY_DEFAULT, LIB_ID_COPY_NO_LIB_OVERRIDE, LIB_ID_MAKELOCAL_FULL_LIBRARY, LIB_ID_MAKELOCAL_LIBOVERRIDE_CLEAR, blender::bke::node_tree_from_id(), and ID::us.

Referenced by BKE_lib_id_make_local().

◆ BKE_lib_id_make_local_generic_action_define()

void BKE_lib_id_make_local_generic_action_define	(	Main *	bmain,
		ID *	id,
		int	flags,
		bool *	r_force_local,
		bool *	r_force_copy )

Helper to decide whether given id can be directly made local, or needs to be copied. r_force_local and r_force_copy cannot be true together. But both can be false, in case no action should be performed.

Note: low-level helper to de-duplicate logic between BKE_lib_id_make_local_generic and the specific corner-cases implementations needed for objects and brushes.

Definition at line 488 of file lib_id.cc.

References BKE_library_ID_test_usages(), BLI_assert, LIB_ID_MAKELOCAL_FORCE_COPY, LIB_ID_MAKELOCAL_FORCE_LOCAL, and LIB_ID_MAKELOCAL_FULL_LIBRARY.

Referenced by BKE_lib_id_make_local_generic(), and brush_make_local().

◆ BKE_lib_id_swap()

void BKE_lib_id_swap	(	Main *	bmain,
		ID *	id_a,
		ID *	id_b,
		const bool	do_self_remap,
		const int	self_remap_flags )

Does a mere memory swap over the whole IDs data (including type-specific memory).

Note: Most internal ID data itself is not swapped (only IDProperties are).

Parameters

bmain	May be NULL, in which case there is no guarantee that internal remapping of ID pointers to themselves will be complete (regarding depsgraph and/or runtime data updates).
do_self_remap	Whether to remap internal pointers to itself or not.
self_remap_flags	Flags controlling self remapping, see BKE_lib_remap.hh.

Definition at line 1022 of file lib_id.cc.

References id_swap().

Referenced by lib_override_id_swap(), and palette_undo_preserve().

◆ BKE_lib_id_swap_full()

void BKE_lib_id_swap_full	(	Main *	bmain,
		ID *	id_a,
		ID *	id_b,
		const bool	do_self_remap,
		const int	self_remap_flags )

Does a mere memory swap over the whole IDs data (including type-specific memory).

Note: All internal ID data itself is also swapped.

For parameters description, see BKE_lib_id_swap above.

Definition at line 1028 of file lib_id.cc.

References id_swap().

Referenced by read_libblock_undo_restore_at_old_address(), and swap_wm_data_for_blendfile().

◆ BKE_lib_libblock_session_uid_ensure()

void BKE_lib_libblock_session_uid_ensure ( ID * id )

Generate a session-wise UID for the given id.

Note: "session-wise" here means while editing a given .blend file. Once a new .blend file is loaded or created, undo history is cleared/reset, and so is the UID counter.

Definition at line 1445 of file lib_id.cc.

References atomic_add_and_fetch_uint32(), BLI_assert, global_session_uid, ID_TAG_TEMP_MAIN, MAIN_ID_SESSION_UID_UNSET, and UNLIKELY.

Referenced by BKE_lib_libblock_session_uid_renew(), BKE_libblock_alloc_in_lib(), BKE_libblock_management_main_add(), create_placeholder(), direct_link_id_common(), and versions_gpencil_add_main().

◆ BKE_lib_libblock_session_uid_renew()

void BKE_lib_libblock_session_uid_renew ( ID * id )

Re-generate a new session-wise UID for the given id.

Warning

This has a few very specific use-cases, no other usage is expected currently:

To handle UI-related data-blocks that are kept across new file reading, when we do keep existing UI.
For IDs that are made local without needing any copying.

Definition at line 1458 of file lib_id.cc.

References BKE_lib_libblock_session_uid_ensure(), and MAIN_ID_SESSION_UID_UNSET.

Referenced by BKE_lib_id_clear_library_data(), reuse_bmain_move_id(), and swap_old_bmain_data_for_blendfile().

◆ BKE_libblock_alloc()

void * BKE_libblock_alloc	(	Main *	bmain,
		short	type,
		const char *	name,
		int	flag )

Allocates and returns an ID block of the specified type, with the specified name (adjusted as necessary to ensure uniqueness), and appended to the specified list. The user count is set to 1, all other content (apart from name and links) being initialized to zero.

Note: By default, IDs allocated in a Main database will get the current library of the Main, i.e. usually (besides in readfile case), they will have a nullptr lib pointer and be local data. IDs allocated outside of a Main database will always get a nullptr lib pointer.

Definition at line 1415 of file lib_id.cc.

References BKE_libblock_alloc_in_lib(), and flag.

Referenced by BKE_curve_add(), BKE_gpencil_data_addnew(), BKE_id_new_nomain(), BKE_linestyle_new(), BKE_mesh_new_nomain(), BKE_object_add_only_object(), BKE_pointcloud_add_default(), BKE_pointcloud_new_nomain(), BKE_sound_new_file(), BKE_text_load_ex(), BKE_vfont_load(), blo_find_main(), cachefile_open_exec(), mask_alloc(), screen_add(), and wm_add_default().

◆ BKE_libblock_alloc_in_lib()

void * BKE_libblock_alloc_in_lib	(	Main *	bmain,
		std::optional< Library * >	owner_library,
		short	type,
		const char *	name,
		int	flag )

Same as for BKE_libblock_alloc, but allows creating a data-block for a given owner library.

Parameters

owner_library the Library to 'assign' the newly created ID to. Use nullptr to make ID not use any library (i.e. become a local ID). Use std::nullopt for default behavior (i.e. behavior of the BKE_libblock_alloc function).

Definition at line 1321 of file lib_id.cc.

References BKE_id_new_name_validate(), BKE_lib_libblock_session_uid_ensure(), BKE_libblock_alloc_notest(), BKE_main_lock(), BKE_main_unlock(), BLI_addtail(), BLI_assert, BLI_strncpy(), Main::curlib, DEG_id_type_tag(), ELEM, flag, ID_GR, ID_NT, ID_TAG_LOCALIZED, ID_TAG_NO_MAIN, ID_TAG_NO_USER_REFCOUNT, ID_WS, Main::is_locked_for_linking, Main::is_memfile_undo_written, LIB_ID_CREATE_LOCAL, LIB_ID_CREATE_NO_ALLOCATE, LIB_ID_CREATE_NO_DEG_TAG, LIB_ID_CREATE_NO_MAIN, LIB_ID_CREATE_NO_USER_REFCOUNT, Library_Runtime::name_map, RenameExistingNever, Library::runtime, ID::tag, and which_libbase().

Referenced by BKE_collection_master_add(), BKE_id_new_in_lib(), BKE_libblock_alloc(), BKE_libblock_copy_in_lib(), image_alloc(), and blender::bke::node_tree_add_tree_do().

◆ BKE_libblock_alloc_notest()

void * BKE_libblock_alloc_notest ( short type )

Allocates and returns memory of the right size for the specified block type, initialized to zero.

Definition at line 1310 of file lib_id.cc.

References BKE_libblock_get_alloc_info(), BLI_assert_msg, and MEM_callocN.

Referenced by BKE_libblock_alloc_in_lib(), create_placeholder(), and blender::deg::IDNode::init_copy_on_write().

◆ BKE_libblock_copy()

void * BKE_libblock_copy	(	Main *	bmain,
		const ID *	id )

Used everywhere in blenkernel.

Note: Typically, the newly copied ID will be a local data (its lib pointer will be nullptr). In practice, ID copying follows the same behavior as ID creation (see BKE_libblock_alloc documentation), with one special case: when the special flag LIB_ID_CREATE_NO_ALLOCATE is specified, the copied ID will have the same library as the source ID.

Definition at line 1646 of file lib_id.cc.

References BKE_libblock_copy_in_lib().

◆ BKE_libblock_copy_ex()

void BKE_libblock_copy_ex	(	Main *	bmain,
		const ID *	id,
		ID **	new_id_p,
		int	orig_flag )

Definition at line 1641 of file lib_id.cc.

References BKE_libblock_copy_in_lib().

◆ BKE_libblock_copy_in_lib()

void BKE_libblock_copy_in_lib	(	Main *	bmain,
		std::optional< Library * >	owner_library,
		const ID *	id,
		const ID *	new_owner_id,
		ID **	new_id_p,
		int	orig_flag )

Same as BKE_libblock_copy_ex, but allows copying data into a library, and not as local data only.

Parameters

owner_library	the Library to 'assign' the newly created ID to. Use `nullptr` to make ID not use any library (i.e. become a local ID). Use #std::nullopt for default behavior (i.e. behavior of the BKE_libblock_copy_ex function).
new_owner_id	When copying an embedded ID, the owner ID of the new copy. Should be `nullptr` for regular ID copying, or in case the owner ID is not (yet) known.

Definition at line 1503 of file lib_id.cc.

References IdAdtTemplate::adt, ID::asset_data, BKE_animdata_copy_in_lib(), BKE_asset_metadata_copy(), BKE_id_name(), BKE_idtype_get_info_from_id(), BKE_lib_override_library_copy(), BKE_libblock_alloc_in_lib(), BKE_libblock_get_alloc_info(), BLI_assert, DEG_id_type_tag(), flag, ID::flag, GS, id_can_have_animdata(), ID_FLAG_EMBEDDED_DATA, ID_FLAG_EMBEDDED_DATA_LIB_OVERRIDE, ID_IS_OVERRIDE_LIBRARY_REAL, ID_IS_OVERRIDE_LIBRARY_VIRTUAL, ID_TAG_COPIED_ON_EVAL, ID_TAG_EXTERN, ID_TAG_INDIRECT, ID_TAG_NO_MAIN, ID_TAG_NO_USER_REFCOUNT, ID_TAG_NOT_ALLOCATED, IDP_CopyProperty_ex(), int, ID::lib, LIB_ID_COPY_ACTIONS, LIB_ID_COPY_ASSET_METADATA, LIB_ID_COPY_NO_ANIMDATA, LIB_ID_COPY_NO_LIB_OVERRIDE, LIB_ID_COPY_SET_COPIED_ON_WRITE, LIB_ID_CREATE_LOCAL, LIB_ID_CREATE_NO_ALLOCATE, LIB_ID_CREATE_NO_DEG_TAG, LIB_ID_CREATE_NO_MAIN, LIB_ID_CREATE_NO_USER_REFCOUNT, ID::library_weak_reference, ID::name, IDTypeInfo::owner_pointer_get, ID::properties, STRNCPY, ID::tag, and ID::us.

Referenced by BKE_id_copy_in_lib(), BKE_libblock_copy(), and BKE_libblock_copy_ex().

◆ BKE_libblock_find_name()

ID * BKE_libblock_find_name	(	Main *	bmain,
		short	type,
		const char *	name,
		const std::optional< Library * >	lib = std::nullopt )

Definition at line 1657 of file lib_id.cc.

References BLI_assert, BLI_findstring(), BLI_listbase_findafter_string_ptr(), lib, offsetof, and which_libbase().

Referenced by arg_handle_python_text_run(), BKE_id_new_name_validate(), BKE_scene_set_name(), blender::io::alembic::build_depsgraph(), blender::io::obj::exporter_main(), blender::io::ply::exporter_main(), blender::io::stl::exporter_main(), blender::ed::geometry::gather_input_ids(), blender::ed::greasepencil::grease_pencil_stroke_material_set_exec(), blender::ed::object::object_select_mirror_exec(), blender::ed::object::object_select_same_collection_exec(), palette_join_exec(), blender::io::usd::TEST_F(), unpack_item_exec(), updateDuplicateCustomBoneShapes(), blender::io::usd::USD_export(), wm_lib_relocate_exec_do(), wm_lib_relocate_invoke(), and WM_operator_properties_id_lookup_from_name_or_session_uid().

◆ BKE_libblock_find_name_and_library()

ID * BKE_libblock_find_name_and_library	(	Main *	bmain,
		short	type,
		const char *	name,
		const char *	lib_name )

Definition at line 1687 of file lib_id.cc.

References BKE_id_name(), BLI_assert, LISTBASE_FOREACH, STREQ, and which_libbase().

◆ BKE_libblock_find_name_and_library_filepath()

ID * BKE_libblock_find_name_and_library_filepath	(	Main *	bmain,
		short	type,
		const char *	name,
		const char *	lib_filepath_abs )

Definition at line 1715 of file lib_id.cc.

References BKE_id_name(), BLI_assert, LISTBASE_FOREACH, STREQ, and which_libbase().

Referenced by blender::bke::asset_edit_id_from_weak_reference(), and undosys_id_ref_resolve().

◆ BKE_libblock_find_session_uid()

ID * BKE_libblock_find_session_uid	(	Main *	bmain,
		short	type,
		uint32_t	session_uid )

Definition at line 1675 of file lib_id.cc.

References BLI_assert, LISTBASE_FOREACH, and which_libbase().

Referenced by blender::ed::object::drop_geometry_nodes_invoke(), blender::ed::object::drop_geometry_nodes_tooltip(), blender::get_modifier_data(), view3d_geometry_nodes_drop_poll(), and WM_operator_properties_id_lookup_from_name_or_session_uid().

◆ BKE_libblock_free_data()

void BKE_libblock_free_data	(	ID *	id,
		bool	do_id_user )

Definition at line 46 of file lib_id_delete.cc.

References BKE_animdata_free(), BKE_asset_metadata_free(), BKE_lib_override_library_free(), IDP_FreePropertyContent_ex(), and MEM_freeN().

Referenced by BKE_collection_free_data(), BKE_object_free_derived_caches(), blender::deg::deg_free_eval_copy_datablock(), id_free(), blender::bke::node_tree_free_embedded_tree(), blender::bke::node_tree_free_local_tree(), blender::bke::ntree_free_data(), particle_settings_free_local(), prefetch_freejob(), and wm_file_read_setup_wm_use_new().

◆ BKE_libblock_free_data_py()

void BKE_libblock_free_data_py ( ID * id )

In most cases BKE_id_free_ex handles this, when lower level functions are called directly this function will need to be called too, if Python has access to the data.

ID data-blocks such as Material.nodetree are not stored in Main.

Definition at line 396 of file lib_id_delete.cc.

References BPY_DECREF_RNA_INVALIDATE(), BPY_id_release(), and UNUSED_VARS.

Referenced by blender::deg::deg_free_eval_copy_datablock(), id_free(), blender::bke::node_tree_free_embedded_tree(), scene_free_data(), and wm_file_read_setup_wm_use_new().

◆ BKE_libblock_free_datablock()

void BKE_libblock_free_datablock	(	ID *	id,
		int	flag )

Definition at line 70 of file lib_id_delete.cc.

References BKE_idtype_get_info_from_id(), BLI_assert_msg, and IDTypeInfo::free_data.

Referenced by BKE_object_free_derived_caches(), blender::deg::deg_free_eval_copy_datablock(), id_free(), particle_settings_free_local(), prefetch_freejob(), preview_id_copy_free(), blender::animrig::tests::ArmatureBoneCollections::TearDown(), blender::animrig::tests::ArmatureBoneCollectionsLiboverrides::TearDown(), blender::animrig::tests::ArmatureBoneCollectionsTestList::TearDown(), and blender::eevee::LookdevWorld::~LookdevWorld().

◆ BKE_libblock_get_alloc_info()

size_t BKE_libblock_get_alloc_info	(	short	type,
		const char **	r_name )

Get allocation size of a given data-block type and optionally allocation r_name.

Definition at line 1293 of file lib_id.cc.

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

Referenced by BKE_id_copy_in_lib(), BKE_libblock_alloc_notest(), and BKE_libblock_copy_in_lib().

◆ BKE_libblock_init_empty()

void BKE_libblock_init_empty ( ID * id )

Initialize an ID of given type, such that it has valid 'empty' data. ID is assumed to be just calloc'ed.

Definition at line 1420 of file lib_id.cc.

References BKE_idtype_get_info_from_id(), BLI_assert_msg, and IDTypeInfo::init_data.

Referenced by BKE_id_new_in_lib(), BKE_id_new_nomain(), BKE_mesh_new_nomain(), create_placeholder(), blender::eevee::LookdevWorld::LookdevWorld(), and blender::bke::node_tree_add_tree_do().

◆ BKE_libblock_management_main_add()

void BKE_libblock_management_main_add	(	Main *	bmain,
		void *	idv )

Add a 'NO_MAIN' data-block to given main (also sets user-counts of its IDs if needed).

Definition at line 1097 of file lib_id.cc.

References BKE_id_new_name_validate(), BKE_lib_libblock_session_uid_ensure(), BKE_library_foreach_ID_link(), BKE_main_lock(), BKE_main_unlock(), BLI_addtail(), BLI_assert, GS, ID_TAG_NO_MAIN, ID_TAG_NO_USER_REFCOUNT, ID_TAG_NOT_ALLOCATED, IDWALK_NOP, Main::is_memfile_undo_written, libblock_management_us_plus(), RenameExistingNever, and which_libbase().

Referenced by BKE_main_merge(), and lib_override_library_resync().

◆ BKE_libblock_management_main_remove()

void BKE_libblock_management_main_remove	(	Main *	bmain,
		void *	idv )

Remove a data-block from given main (set it to 'NO_MAIN' status).

Definition at line 1130 of file lib_id.cc.

References BKE_id_name(), BKE_main_lock(), BKE_main_namemap_remove_name(), BKE_main_unlock(), BLI_assert, BLI_remlink(), GS, ID_TAG_NO_MAIN, Main::is_memfile_undo_written, and which_libbase().

Referenced by BKE_main_merge().

◆ BKE_libblock_management_usercounts_clear()

void BKE_libblock_management_usercounts_clear	(	Main *	bmain,
		void *	idv )

Definition at line 1162 of file lib_id.cc.

References BKE_library_foreach_ID_link(), ID_TAG_NO_MAIN, ID_TAG_NO_USER_REFCOUNT, IDWALK_NOP, and libblock_management_us_min().

◆ BKE_libblock_management_usercounts_set()

void BKE_libblock_management_usercounts_set	(	Main *	bmain,
		void *	idv )

Definition at line 1150 of file lib_id.cc.

References BKE_library_foreach_ID_link(), ID_TAG_NO_USER_REFCOUNT, IDWALK_NOP, and libblock_management_us_plus().

◆ BKE_libblock_rename()

IDNewNameResult BKE_libblock_rename	(	Main &	bmain,
		ID &	id,
		blender::StringRefNull	name,
		const IDNewNameMode	mode = IDNewNameMode::RenameExistingNever )

Sets the name of a block to name, suitably adjusted for uniqueness.

Returns: true if the name of the ID was actually modified.

Definition at line 2316 of file lib_id.cc.

References BKE_id_is_in_main(), BKE_id_name(), BKE_id_new_name_validate(), BKE_main_namemap_remove_name(), BLI_assert, ELEM, GS, Main::is_memfile_undo_written, result, STREQ, IDNewNameResult::UNCHANGED, IDNewNameResult::UNCHANGED_COLLISION, and which_libbase().

Referenced by blender::bke::asset_write_in_library(), BKE_id_rename(), BLO_update_defaults_startup_blend(), blender::bke::tests::change_name(), do_versions_rename_id(), blender::bke::tests::TEST(), wm_file_read_post(), workspace_append_activate_exec(), and DocumentImporter::write_node().

◆ BKE_libblock_runtime_reset_remapping_status()

void BKE_libblock_runtime_reset_remapping_status ( ID * id )

Reset the runtime counters used by ID remapping.

Definition at line 1434 of file lib_id.cc.

Referenced by libblock_remap_foreach_idpair(), and libblock_remap_reset_remapping_status_fn().

◆ BKE_library_make_local()

void BKE_library_make_local	(	Main *	bmain,
		const Library *	lib,
		GHash *	old_to_new_ids,
		bool	untagged_only,
		bool	set_fake,
		bool	clear_asset_data )

Make linked data-blocks local.

Parameters

bmain	Almost certainly global main.
lib	If not NULL, only make local data-blocks from this library.
untagged_only	If true, only make local data-blocks not tagged with ID_TAG_PRE_EXISTING.
set_fake	If true, set fake user on all localized data-blocks (except group and objects ones).
clear_asset_data	If true, clear the asset metadata on all localized data-blocks, making them normal non-asset data-blocks.

Definition at line 2075 of file lib_id.cc.

References BKE_idtype_idcode_is_linkable(), BKE_lib_id_clear_library_data(), BKE_lib_id_expand_local(), BKE_lib_id_make_local(), BKE_lib_override_library_main_hierarchy_root_ensure(), BKE_lib_override_library_make_local(), BKE_libblock_remap(), BKE_main_id_newptr_and_tag_clear(), BKE_main_relations_create(), BKE_main_relations_free(), BKE_pose_rebuild(), BKE_rigidbody_ensure_local_object(), BLI_assert, BLI_ghash_insert(), BLI_gset_add(), BLI_gset_free(), BLI_gset_len(), BLI_gset_ptr_new(), BLI_linklist_prepend_arena(), BLI_linklist_prepend_nlink(), BLI_memarena_free(), BLI_memarena_new(), ELEM, ListBase::first, GS, id_fake_user_set(), ID_GR, ID_IS_LINKED, ID_IS_OVERRIDE_LIBRARY_REAL, ID_OB, ID_REMAP_SKIP_INDIRECT_USAGE, ID_TAG_DOIT, ID_TAG_EXTERN, ID_TAG_INDIRECT, ID_TAG_NEW, ID_TAG_PRE_EXISTING, id_us_ensure_real(), INDEX_ID_MAX, lib, LIB_ID_MAKELOCAL_ASSET_DATA_CLEAR, LIB_ID_MAKELOCAL_FULL_LIBRARY, library_make_local_copying_check(), LinkNode::next, blender::bke::node_tree_from_id(), OB_ARMATURE, Main::objects, POSE_RECALC, printf, Main::relations, set_listbasepointers(), ID::tag, TIMEIT_END, TIMEIT_START, and TIMEIT_VALUE_PRINT.

Referenced by blender::ed::object::make_local_exec(), and blender::bke::blendfile::PartialWriteContext::write().

◆ BKE_main_id_flag_all()

void BKE_main_id_flag_all	(	Main *	bmain,
		int	flag,
		bool	value )

Clear or set given flags for all ids in bmain (persistent flags).

Definition at line 1225 of file lib_id.cc.

References BKE_main_id_flag_listbase(), flag, INDEX_ID_MAX, and set_listbasepointers().

◆ BKE_main_id_flag_listbase()

void BKE_main_id_flag_listbase	(	ListBase *	lb,
		int	flag,
		bool	value )

Clear or set given flags for all ids in listbase (persistent flags).

Definition at line 1209 of file lib_id.cc.

References ListBase::first, flag, and ID::tag.

Referenced by BKE_main_id_flag_all(), and id_search_cb_objects_from_scene().

◆ BKE_main_id_newptr_and_tag_clear()

void BKE_main_id_newptr_and_tag_clear ( Main * bmain )

Next to indirect usage in readfile.cc / writefile.cc also in editobject.c, scene.cc.

Definition at line 1947 of file lib_id.cc.

References BKE_id_newptr_and_tag_clear(), FOREACH_MAIN_ID_BEGIN, and FOREACH_MAIN_ID_END.

◆ BKE_main_id_refcount_recompute()

void BKE_main_id_refcount_recompute	(	Main *	bmain,
		bool	do_linked_only )

Definition at line 1981 of file lib_id.cc.

References BKE_library_foreach_ID_link(), ELEM, FOREACH_MAIN_ID_BEGIN, FOREACH_MAIN_ID_END, GS, ID_FAKE_USERS, ID_IS_LINKED, id_refcount_recompute_callback(), ID_SCE, ID_TAG_EXTRAUSER, ID_TAG_EXTRAUSER_SET, id_us_ensure_real(), ID_WM, ID_WS, IDWALK_INCLUDE_UI, IDWALK_READONLY, POINTER_FROM_INT, and ID::us.

Referenced by blender::bke::asset_main_create_from_ID(), BKE_blendfile_library_relocate(), blo_read_file_internal(), library_link_end(), setup_app_data(), and write_file_handle().

◆ BKE_main_id_repair_duplicate_names_listbase()

void BKE_main_id_repair_duplicate_names_listbase	(	Main *	bmain,
		ListBase *	lb )

Only for repairing files via versioning, avoid for general use.

Definition at line 1235 of file lib_id.cc.

References BKE_id_name(), BKE_id_new_name_validate(), BLI_gset_add(), BLI_gset_free(), BLI_gset_str_new_ex(), ID_IS_LINKED, LISTBASE_FOREACH, MEM_freeN(), MEM_mallocN, and RenameExistingNever.

Referenced by blo_do_versions_280(), blo_do_versions_290(), and blo_do_versions_300().

◆ BKE_main_id_tag_all()

void BKE_main_id_tag_all	(	Main *	mainvar,
		int	tag,
		bool	value )

Clear or set given tags for all ids in bmain (runtime tags).

Definition at line 1198 of file lib_id.cc.

References BKE_main_id_tag_listbase(), INDEX_ID_MAX, and set_listbasepointers().

Referenced by BKE_blendfile_append(), BKE_blendfile_library_relocate(), BKE_lib_override_library_create(), BKE_lib_override_library_delete(), blo_read_file_internal(), bpy_batch_remove(), bpy_lib_exit(), copybuffer_append(), blender::ed::outliner::id_override_library_create_hierarchy(), blender::ed::outliner::id_override_library_create_hierarchy_pre_process(), lib_override_library_main_resync_on_library_indirect_level(), lib_override_library_resync(), library_link_end(), blender::ed::object::make_local_exec(), blender::ed::object::make_override_library_exec(), blender::ed::object::object_delete_exec(), blender::ed::outliner::outliner_delete_exec(), blender::ed::outliner::outliner_id_delete_invoke(), blender::ed::outliner::outliner_id_operation_exec(), blender::ed::outliner::outliner_lib_operation_exec(), previews_ensure_exec(), blender::ed::object::sorted_selected_editable_objects(), blender::ed::object::tag_localizable_objects(), wm_file_link_append_datablock_ex(), WM_lib_reload(), wm_lib_relocate_exec_do(), and wm_link_append_exec().

◆ BKE_main_id_tag_idcode()

void BKE_main_id_tag_idcode	(	Main *	mainvar,
		short	type,
		int	tag,
		bool	value )

Clear or set given tags for all ids of given type in bmain (runtime tags).

Note: Affect whole Main database.

Definition at line 1191 of file lib_id.cc.

References BKE_main_id_tag_listbase(), and which_libbase().

Referenced by blender::ed::object::bake_objects_check(), blender::ed::object::bake_targets_init_image_textures(), BKE_blendfile_library_relocate(), blender::ed::outliner::id_delete_tag(), and sound_update_animation_flags_exec().

◆ BKE_main_id_tag_listbase()

void BKE_main_id_tag_listbase	(	ListBase *	lb,
		int	tag,
		bool	value )

Clear or set given tags for all ids in listbase (runtime tags).

Definition at line 1175 of file lib_id.cc.

References ListBase::first, and ID::tag.

Referenced by BKE_collection_object_cyclic_check(), BKE_main_id_tag_all(), BKE_main_id_tag_idcode(), BKE_workspace_id_tag_all_visible(), clean_viewport_memory(), blender::ed::object::object_delete_exec(), and previews_ensure_exec().

◆ BKE_main_lib_objects_recalc_all()

void BKE_main_lib_objects_recalc_all ( Main * bmain )

Definition at line 1267 of file lib_id.cc.

References DEG_id_tag_update(), DEG_id_type_tag(), ListBase::first, Object::id, ID_IS_LINKED, ID_OB, ID_RECALC_ANIMATION, ID_RECALC_GEOMETRY, ID_RECALC_TRANSFORM, ID::next, and Main::objects.

Referenced by copybuffer_append(), blender::ed::outliner::outliner_id_remap_exec(), WM_lib_reload(), wm_lib_relocate_exec_do(), and wm_link_append_exec().

◆ id_fake_user_clear()

void id_fake_user_clear ( ID * id )

Definition at line 397 of file lib_id.cc.

References ID_FLAG_FAKEUSER, and id_us_min().

Referenced by BKE_lib_id_clear_library_data(), blendfile_library_relocate_remap(), blender::ed::asset::clear_id(), blender::ed::outliner::collection_link_exec(), ED_animedit_unlink_action(), blender::ed::outliner::id_fake_user_clear_fn(), lib_id_fake_user_toggle_exec(), libblock_remap_data_update_tags(), and template_id_cb().

◆ id_fake_user_set()

void id_fake_user_set ( ID * id )

Definition at line 389 of file lib_id.cc.

References ID_FLAG_FAKEUSER, and id_us_plus().

Referenced by blender::bke::asset_write_in_library(), BKE_blendfile_append(), BKE_lib_id_clear_library_data(), BKE_library_make_local(), BKE_text_add(), BKE_text_load_ex(), blendfile_library_relocate_remap(), brush_copy_data(), brush_init_data(), brush_make_local(), blender::ed::object::collection_add_exec(), blender::ed::object::collection_create_exec(), do_versions_after_linking_280(), do_versions_after_linking_290(), do_versions_after_linking_300(), blender::io::usd::USDStageReader::fake_users_for_unused_materials(), blender::ed::outliner::id_fake_user_set_fn(), blender::bke::greasepencil::convert::legacy_gpencil_to_grease_pencil(), lib_id_fake_user_toggle_exec(), lib_override_library_resync(), libblock_remap_data_update_tags(), blender::ed::asset::mark_id(), mask_alloc(), mask_copy_data(), blender::ed::asset::AssetClearHelper::operator()(), palette_init_data(), and blender::ed::outliner::unlink_collection_fn().

◆ id_lib_extern()

void id_lib_extern ( ID * id )

Definition at line 283 of file lib_id.cc.

References BKE_idtype_idcode_is_linkable(), BLI_assert, GS, ID_IS_LINKED, ID_TAG_EXTERN, and ID_TAG_INDIRECT.

Referenced by con_extern_cb(), id_us_plus(), lib_id_expand_local_cb(), paste_material_nodetree_ids_relink_or_clear(), paste_mtex_copybuf(), write_file_handle(), and write_id_direct_linked_data_process_cb().

◆ id_lib_indirect_weak_link()

void id_lib_indirect_weak_link ( ID * id )

Definition at line 296 of file lib_id.cc.

References BKE_idtype_idcode_is_linkable(), BLI_assert, GS, ID_FLAG_INDIRECT_WEAK_LINK, ID_IS_LINKED, and ID_TAG_INDIRECT.

Referenced by layer_collection_objects_sync(), layer_collection_sync(), and write_id_direct_linked_data_process_cb().

◆ id_single_user()

bool id_single_user	(	bContext *	C,
		ID *	id,
		PointerRNA *	ptr,
		PropertyRNA *	prop )

Note: Does not set ID.newid pointer.

Definition at line 1034 of file lib_id.cc.

References BKE_id_copy_ex(), CTX_data_main(), DEG_id_tag_update(), bGPdata::flag, GS, ID_GD_LEGACY, ID_REAL_USERS, ID_RECALC_GEOMETRY, ID_RECALC_TRANSFORM, id_us_min(), LIB_ID_COPY_ACTIONS, LIB_ID_COPY_DEFAULT, ptr, RNA_id_pointer_create(), RNA_property_editable(), RNA_property_pointer_set(), and RNA_property_update().

Referenced by blender::ed::outliner::singleuser_action_fn(), blender::ed::outliner::singleuser_world_fn(), and template_id_cb().

◆ id_sort_by_name()

void id_sort_by_name	(	ListBase *	lb,
		ID *	id,
		ID *	id_sorting_hint )

Sort given id into given lb list, using case-insensitive comparison of the id names.

Note: All other IDs beside given one are assumed already properly sorted in the list.

Parameters

id_sorting_hint Ignored if NULL. Otherwise, used to check if we can insert id immediately before or after that pointer. It must always be into given lb list.

Definition at line 1737 of file lib_id.cc.

References BLI_addhead(), BLI_addtail(), BLI_assert, BLI_findindex(), BLI_insertlinkafter(), BLI_insertlinkbefore(), BLI_remlink(), BLI_strcasecmp(), ELEM, ListBase::first, ID_IS_LINKED, ID_SORT_STEP_SIZE, ListBase::last, ID::lib, ID::name, ID::next, and ID::prev.

Referenced by blender::bke::tests::add_id_in_library(), BKE_id_new_name_validate(), blendfile_library_relocate_remap(), blender::bke::tests::change_name_global(), create_placeholder(), expand_doit_library(), lib_override_library_create_from(), link_named_part(), sort_linked_ids(), blender::bke::tests::TEST(), blender::bke::tests::TEST(), and blender::bke::tests::TEST().

◆ id_us_clear_real()

void id_us_clear_real ( ID * id )

Definition at line 324 of file lib_id.cc.

References BLI_assert, ID_FAKE_USERS, ID_TAG_EXTRAUSER, and ID_TAG_EXTRAUSER_SET.

Referenced by blender::animrig::action_add(), BKE_blendfile_library_relocate(), BKE_id_free_us(), libblock_remap_data_update_tags(), libblock_remap_foreach_idpair(), blender::bke::blendfile::PartialWriteContext::remove_unused(), and template_id_cb().

◆ id_us_ensure_real()

void id_us_ensure_real ( ID * id )

Ensure we have a real user

Note: Now that we have flags, we could get rid of the 'fake_user' special case, flags are enough to ensure we always have a real user. However, ID_REAL_USERS is used in several places outside of core lib.c, so think we can wait later to make this change.

Definition at line 306 of file lib_id.cc.

References CLOG_ERROR, ID_FAKE_USERS, ID_TAG_EXTRAUSER, ID_TAG_EXTRAUSER_SET, and LOG.

Referenced by blender::bke::id::IDRemapper::apply(), BKE_image_ensure_viewer(), BKE_library_make_local(), BKE_library_update_ID_link_user(), BKE_main_id_refcount_recompute(), BKE_scene_add(), BKE_scene_duplicate(), BKE_workspace_add(), blo_find_main(), direct_link_library(), ED_node_tree_push(), ED_node_tree_start(), ED_node_tree_update(), ED_space_clip_set_clip(), ED_space_clip_set_mask(), ED_space_image_set(), ED_space_image_set_mask(), foreach_libblock_make_usercounts_callback(), foreach_libblock_remap_callback_apply(), id_refcount_recompute_callback(), id_us_min(), libblock_management_us_plus(), blender::ed::space_node::node_id_remap(), paste_material_nodetree_ids_relink_or_clear(), scene_blend_read_data(), SEQ_add_mask_strip(), SEQ_add_movieclip_strip(), SEQ_add_scene_strip(), window_manager_blend_read_data(), and workspace_blend_read_data().

◆ id_us_min()

void id_us_min ( ID * id )

Definition at line 359 of file lib_id.cc.

References CLOG_ERROR, GS, ID_FAKE_USERS, ID_TAG_EXTRAUSER, ID_TYPE_IS_DEPRECATED, id_us_ensure_real(), and LOG.

◆ id_us_plus()

void id_us_plus ( ID * id )

Definition at line 351 of file lib_id.cc.

References id_lib_extern(), and id_us_plus_no_lib().

◆ id_us_plus_no_lib()

void id_us_plus_no_lib ( ID * id )

Same as id_us_plus, but does not handle lib indirect -> extern. Only used by readfile.cc so far, but simpler/safer to keep it here nonetheless.

Definition at line 335 of file lib_id.cc.

References BLI_assert, ID_TAG_EXTRAUSER, and ID_TAG_EXTRAUSER_SET.

Referenced by blender::bke::id::IDRemapper::apply(), BKE_blendfile_library_relocate(), foreach_libblock_remap_callback_apply(), id_copy_libmanagement_cb(), id_refcount_recompute_callback(), id_us_plus(), blender::bke::greasepencil::convert::legacy_gpencil_sanitize_annotations(), and scene_foreach_toolsettings_id_pointer_process().

Classes

Macros

Enumerations

Functions

Detailed Description

Names

Macro Definition Documentation

◆ IS_TAGGED

◆ MAIN_ID_SESSION_UID_UNSET

◆ MAX_ID_FULL_NAME

◆ MAX_ID_FULL_NAME_UI

Enumeration Type Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ eLibIDDuplicateFlags

◆ IDNewNameMode

Function Documentation

◆ BKE_id_blend_write()

◆ BKE_id_can_be_asset()

◆ BKE_id_can_use_id()

◆ BKE_id_copy()

◆ BKE_id_copy_ex()

◆ BKE_id_copy_for_duplicate()

◆ BKE_id_copy_for_use_in_bmain()

◆ BKE_id_copy_in_lib()

◆ BKE_id_copy_is_allowed()

◆ BKE_id_delete()

◆ BKE_id_delete_ex()

◆ BKE_id_eval_properties_copy()

◆ BKE_id_free()

◆ BKE_id_free_ex()

◆ BKE_id_free_us()

◆ BKE_id_full_name_get()

◆ BKE_id_full_name_ui_prefix_get()

◆ BKE_id_is_editable()

◆ BKE_id_is_in_global_main()

◆ BKE_id_is_in_main()

◆ BKE_id_move_to_same_lib()

◆ BKE_id_multi_delete()

◆ BKE_id_multi_tagged_delete()

◆ BKE_id_name() [1/2]

◆ BKE_id_name() [2/2]

◆ BKE_id_new()

◆ BKE_id_new_in_lib()

◆ BKE_id_new_name_validate()

◆ BKE_id_new_nomain()

◆ BKE_id_newptr_and_tag_clear()

◆ BKE_id_ordered_list()

◆ BKE_id_owner_get()

◆ BKE_id_rename()

◆ BKE_id_reorder()

◆ BKE_id_tag_clear_atomic()

◆ BKE_id_tag_set_atomic()

◆ BKE_id_to_unique_string_key()

◆ BKE_lib_id_clear_library_data()

◆ BKE_lib_id_expand_local()

◆ BKE_lib_id_make_local()

◆ BKE_lib_id_make_local_generic()

◆ BKE_lib_id_make_local_generic_action_define()

◆ BKE_lib_id_swap()

◆ BKE_lib_id_swap_full()

◆ BKE_lib_libblock_session_uid_ensure()

◆ BKE_lib_libblock_session_uid_renew()

◆ BKE_libblock_alloc()

◆ BKE_libblock_alloc_in_lib()

◆ BKE_libblock_alloc_notest()

◆ BKE_libblock_copy()

◆ BKE_libblock_copy_ex()

◆ BKE_libblock_copy_in_lib()

◆ BKE_libblock_find_name()

◆ BKE_libblock_find_name_and_library()

◆ BKE_libblock_find_name_and_library_filepath()

◆ BKE_libblock_find_session_uid()

◆ BKE_libblock_free_data()

◆ BKE_libblock_free_data_py()

◆ BKE_libblock_free_datablock()

◆ BKE_libblock_get_alloc_info()

◆ BKE_libblock_init_empty()

◆ BKE_libblock_management_main_add()