Blender: BlendfileLinkAppendContext Struct Reference

Blender V4.3

#include <BKE_blendfile_link_append.hh>

Public Types
enum class	ProcessStage { Init = 0 , Linking , Appending , Instantiating , Done }

using	items_iterator_t = std::list<BlendfileLinkAppendContextItem>::iterator

Public Attributes
blender::Vector< BlendfileLinkAppendContextLibrary >	libraries

std::list< BlendfileLinkAppendContextItem >	items

LibraryLink_Params *	params = nullptr

ProcessStage	process_stage

blender::Map< ID , BlendfileLinkAppendContextItem >	new_id_to_item

MainLibraryWeakReferenceMap *	library_weak_reference_mapping = nullptr

const void *	blendfile_mem = nullptr

size_t	blendfile_memsize = 0

Detailed Description

General container for all relevant data for a library/linked-data related operation (linking, appending, library relocating, etc.).

Definition at line 118 of file BKE_blendfile_link_append.hh.

Member Typedef Documentation

◆ items_iterator_t

using BlendfileLinkAppendContext::items_iterator_t = std::list<BlendfileLinkAppendContextItem>::iterator

Definition at line 126 of file BKE_blendfile_link_append.hh.

Member Enumeration Documentation

◆ ProcessStage

enum class BlendfileLinkAppendContext::ProcessStage

strong

What is the current stage of the link/append process. Used mainly by the RNA wrappers for the pre/post handlers currently.

Enumerator
Init	The context data is being filled with data (Libraries and IDs) to process. Nothing has been linked yet.
Linking	The context data is being used to linked IDs.
Appending	The context data is being used to append IDs (i.e. make local linked ones, or re-use already existing local ones).
Instantiating	The context data is being used to instantiate (loose) IDs (i.e. ensure that Collections, Objects and/or ObjectData IDs are added to the current scene).
Done	All data has been linked or appended. The context state represents the final result of the process.

Definition at line 134 of file BKE_blendfile_link_append.hh.

Member Data Documentation

◆ blendfile_mem

const void* BlendfileLinkAppendContext::blendfile_mem = nullptr

Embedded blendfile and its size, if needed.

Definition at line 170 of file BKE_blendfile_link_append.hh.

Referenced by BKE_blendfile_link_append_context_embedded_blendfile_clear(), BKE_blendfile_link_append_context_embedded_blendfile_set(), and link_append_context_library_blohandle_ensure().

◆ blendfile_memsize

size_t BlendfileLinkAppendContext::blendfile_memsize = 0

Definition at line 171 of file BKE_blendfile_link_append.hh.

Referenced by BKE_blendfile_link_append_context_embedded_blendfile_clear(), BKE_blendfile_link_append_context_embedded_blendfile_set(), and link_append_context_library_blohandle_ensure().

◆ items

std::list<BlendfileLinkAppendContextItem> BlendfileLinkAppendContext::items

List of all ID to try to link from libraries. This is a linked list because iterators must not be invalidated when adding more items.

Definition at line 125 of file BKE_blendfile_link_append.hh.

Referenced by BKE_blendfile_append(), BKE_blendfile_library_relocate(), BKE_blendfile_link(), BKE_blendfile_link_append_context_is_empty(), BKE_blendfile_link_append_context_item_add(), BKE_blendfile_link_append_context_item_foreach(), BKE_blendfile_link_append_context_library_add(), BKE_blendfile_link_append_instantiate_loose(), BKE_blendfile_override(), blendfile_append_define_actions(), loose_data_instantiate_collection_process(), loose_data_instantiate_obdata_preprocess(), loose_data_instantiate_obdata_process(), loose_data_instantiate_object_process(), loose_data_instantiate_object_rigidbody_postprocess(), and new_id_to_item_mapping_create().

◆ libraries

blender::Vector<BlendfileLinkAppendContextLibrary> BlendfileLinkAppendContext::libraries

List of library paths to search IDs in.

Definition at line 120 of file BKE_blendfile_link_append.hh.

Referenced by BKE_blendfile_link(), BKE_blendfile_link_append_context_free(), BKE_blendfile_link_append_context_item_add(), BKE_blendfile_link_append_context_item_idtypes_from_library_add(), and BKE_blendfile_link_append_context_library_add().

◆ library_weak_reference_mapping

MainLibraryWeakReferenceMap* BlendfileLinkAppendContext::library_weak_reference_mapping = nullptr

Runtime info used by append code to manage re-use of already appended matching IDs.

Definition at line 167 of file BKE_blendfile_link_append.hh.

Referenced by BKE_blendfile_append(), BKE_blendfile_link_append_context_free(), and blendfile_append_define_actions().

◆ new_id_to_item

blender::Map<ID *, BlendfileLinkAppendContextItem *> BlendfileLinkAppendContext::new_id_to_item

Allows to easily find an existing items from an ID pointer.

Definition at line 164 of file BKE_blendfile_link_append.hh.

Referenced by BKE_blendfile_link_append_context_item_newid_set(), foreach_libblock_append_add_dependencies_callback(), foreach_libblock_append_ensure_reusable_local_id_callback(), foreach_libblock_append_finalize_action_callback(), foreach_libblock_link_finalize_cb(), and new_id_to_item_mapping_add().

◆ params

LibraryLink_Params* BlendfileLinkAppendContext::params = nullptr

Linking/appending parameters. Including bmain, scene, viewlayer and view3d.

Definition at line 128 of file BKE_blendfile_link_append.hh.

Referenced by BKE_blendfile_append(), BKE_blendfile_library_relocate(), BKE_blendfile_link(), BKE_blendfile_link_append_context_finalize(), BKE_blendfile_link_append_context_flag_set(), BKE_blendfile_link_append_context_init_done(), BKE_blendfile_link_append_context_item_idtypes_from_library_add(), BKE_blendfile_link_append_context_new(), BKE_blendfile_link_append_instantiate_loose(), BKE_blendfile_override(), blendfile_append_define_actions(), loose_data_instantiate(), loose_data_instantiate_collection_process(), loose_data_instantiate_ensure_active_collection(), loose_data_instantiate_obdata_process(), loose_data_instantiate_object_process(), loose_data_instantiate_object_rigidbody_postprocess(), and loose_data_instantiate_process_check().

◆ process_stage

ProcessStage BlendfileLinkAppendContext::process_stage

Definition at line 161 of file BKE_blendfile_link_append.hh.

Referenced by BKE_blendfile_append(), BKE_blendfile_link(), BKE_blendfile_link_append_context_finalize(), BKE_blendfile_link_append_context_init_done(), BKE_blendfile_link_append_context_item_idtypes_from_library_add(), BKE_blendfile_link_append_context_item_liboverrideid_get(), BKE_blendfile_link_append_context_item_library_index_enable(), BKE_blendfile_link_append_context_item_newid_get(), BKE_blendfile_link_append_context_item_newid_set(), BKE_blendfile_link_append_context_library_add(), BKE_blendfile_link_append_context_new(), and BKE_blendfile_link_append_instantiate_loose().

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

BKE_blendfile_link_append.hh