#include "BLI_compiler_compat.h"
#include "BLI_ghash.h"
#include "BLI_iterator.h"
#include "BLI_sys_types.h"
#include "DNA_listBase.h"

Classes
struct	CollectionParent

struct	SceneObjectsIteratorExData

Macros
#define	BKE_SCENE_COLLECTION_NAME "Scene Collection"

#define	FOREACH_COLLECTION_VISIBLE_OBJECT_RECURSIVE_BEGIN(_collection, _object, _mode)

#define	FOREACH_COLLECTION_VISIBLE_OBJECT_RECURSIVE_END

#define	FOREACH_COLLECTION_OBJECT_RECURSIVE_BEGIN(_collection, _object)

#define	FOREACH_COLLECTION_OBJECT_RECURSIVE_END

#define	FOREACH_SCENE_COLLECTION_BEGIN(scene, _instance)

#define	FOREACH_SCENE_COLLECTION_END ITER_END

#define	FOREACH_COLLECTION_BEGIN(_bmain, _scene, Type, _instance)

#define	FOREACH_COLLECTION_END

#define	FOREACH_SCENE_OBJECT_BEGIN(scene, _instance)

#define	FOREACH_SCENE_OBJECT_END ITER_END

Typedefs
using	BKE_scene_objects_Cb = void ()(Object ob, void *data)

using	BKE_scene_collections_Cb = void ()(Collection ob, void *data)

Functions
Collection *	BKE_collection_add (Main bmain, Collection collection_parent, const char *name_custom)

void	BKE_collection_add_from_object (Main bmain, Scene scene, const Object ob_src, Collection collection_dst)

void	BKE_collection_add_from_collection (Main bmain, Scene scene, Collection collection_src, Collection collection_dst)

void	BKE_collection_free_data (Collection *collection)

void	BKE_collection_exporter_name_set (const ListBase exporters, CollectionExport data, const char *newname)

void	BKE_collection_exporter_free_data (CollectionExport *data)

bool	BKE_collection_delete (Main bmain, Collection collection, bool hierarchy)

Collection *	BKE_collection_duplicate (Main bmain, Collection parent, CollectionChild child_old, Collection collection, uint duplicate_flags, uint duplicate_options)

Collection *	BKE_collection_master_add (Scene *scene)

bool	BKE_collection_has_object (Collection collection, const Object ob)

bool	BKE_collection_has_object_recursive (Collection collection, Object ob)

bool	BKE_collection_has_object_recursive_instanced (Collection collection, Object ob)

bool	BKE_collection_has_object_recursive_instanced_orig_id (Collection collection_eval, Object object_eval)

Collection *	BKE_collection_object_find (Main bmain, Scene scene, Collection collection, Object ob)

CollectionChild *	BKE_collection_child_find (Collection parent, Collection collection)

bool	BKE_collection_is_empty (const Collection *collection)

bool	BKE_collection_object_add (Main bmain, Collection collection, Object *ob)

bool	BKE_collection_viewlayer_object_add (Main bmain, const ViewLayer view_layer, Collection collection, Object ob)

bool	BKE_collection_object_add_notest (Main bmain, Collection collection, Object *ob)

void	BKE_collection_object_add_from (Main bmain, Scene scene, Object ob_src, Object ob_dst)

bool	BKE_collection_object_remove (Main bmain, Collection collection, Object *ob, bool free_us)

bool	BKE_collection_object_replace (Main bmain, Collection collection, Object ob_old, Object ob_new)

void	BKE_collection_object_move (Main bmain, Scene scene, Collection collection_dst, Collection collection_src, Object *ob)

bool	BKE_scene_collections_object_remove (Main bmain, Scene scene, Object *ob, bool free_us)

void	BKE_collections_object_remove_invalids (Main *bmain)

void	BKE_collections_child_remove_nulls (Main bmain, Collection parent_collection, Collection *child_collection)

bool	BKE_collection_is_in_scene (Collection *collection)

void	BKE_collections_after_lib_link (Main *bmain)

bool	BKE_collection_object_cyclic_check (Main bmain, Object object, Collection *collection)

ListBase	BKE_collection_object_cache_get (Collection *collection)

ListBase	BKE_collection_object_cache_instanced_get (Collection *collection)

void	BKE_collection_object_cache_free (const Main bmain, Collection collection, const int id_create_flag)

void	BKE_main_collections_object_cache_free (const Main *bmain)

Base *	BKE_collection_or_layer_objects (const Scene scene, ViewLayer view_layer, Collection *collection)

Collection *	BKE_collection_from_index (Scene *scene, int index)

void	BKE_collection_new_name_get (Collection collection_parent, char rname)

const char *	BKE_collection_ui_name_get (Collection *collection)

bool	BKE_collection_objects_select (const Scene scene, ViewLayer view_layer, Collection *collection, bool deselect)

bool	BKE_collection_child_add (Main bmain, Collection parent, Collection *child)

bool	BKE_collection_child_add_no_sync (Main bmain, Collection parent, Collection *child)

bool	BKE_collection_child_remove (Main bmain, Collection parent, Collection *child)

bool	BKE_collection_move (Main bmain, Collection to_parent, Collection from_parent, Collection relative, bool relative_after, Collection *collection)

bool	BKE_collection_cycle_find (Collection new_ancestor, Collection collection)

bool	BKE_collection_cycles_fix (Main bmain, Collection collection)

bool	BKE_collection_has_collection (const Collection parent, const Collection collection)

Collection *	BKE_collection_parent_editable_find_recursive (const ViewLayer view_layer, Collection collection)

void	BKE_collection_parent_relations_rebuild (Collection *collection)

void	BKE_main_collections_parent_relations_rebuild (Main *bmain)

bool	BKE_collection_validate (Collection *collection)

void	BKE_collection_blend_write_prepare_nolib (BlendWriter writer, Collection collection)

void	BKE_collection_blend_write_nolib (BlendWriter writer, Collection collection)

void	BKE_collection_blend_read_data (BlendDataReader reader, Collection collection, ID *owner_id)

void	BKE_scene_collections_iterator_begin (BLI_Iterator iter, void data_in)

void	BKE_scene_collections_iterator_next (BLI_Iterator *iter)

void	BKE_scene_collections_iterator_end (BLI_Iterator *iter)

void	BKE_scene_objects_iterator_begin (BLI_Iterator iter, void data_in)

void	BKE_scene_objects_iterator_next (BLI_Iterator *iter)

void	BKE_scene_objects_iterator_end (BLI_Iterator *iter)

void	BKE_scene_objects_iterator_begin_ex (BLI_Iterator iter, void data_in)

void	BKE_scene_objects_iterator_next_ex (BLI_Iterator *iter)

void	BKE_scene_objects_iterator_end_ex (BLI_Iterator *iter)

GSet *	BKE_scene_objects_as_gset (Scene scene, GSet objects_gset)

Macro Definition Documentation

◆ BKE_SCENE_COLLECTION_NAME

#define BKE_SCENE_COLLECTION_NAME "Scene Collection"

Definition at line 107 of file BKE_collection.hh.

Referenced by BKE_collection_master_add(), and blo_do_versions_300().

◆ FOREACH_COLLECTION_BEGIN

#define FOREACH_COLLECTION_BEGIN	(	_bmain,
		_scene,
		Type,
		_instance )

Value:

  { \
    Type _instance; \
    Collection *_instance_next; \
    bool is_scene_collection = (_scene) != NULL; \
\
    if (_scene) { \
      _instance_next = _scene->master_collection; \
    } \
    else { \
      _instance_next = static_cast<Collection *>((_bmain)->collections.first); \
    } \
\
    while ((_instance = _instance_next)) { \
      if (is_scene_collection) { \
        _instance_next = static_cast<Collection *>((_bmain)->collections.first); \
        is_scene_collection = false; \
      } \
      else { \
        _instance_next = static_cast<Collection *>(_instance->id.next); \
      }

Definition at line 419 of file BKE_collection.hh.

Referenced by blender::ed::object::collection_objects_remove_exec(), blender::ed::object::objects_add_active_exec(), and blender::ed::object::objects_remove_active_exec().

◆ FOREACH_COLLECTION_END

#define FOREACH_COLLECTION_END

Value:

  } \
  } \
  ((void)0)

Definition at line 441 of file BKE_collection.hh.

Referenced by blender::ed::object::collection_objects_remove_exec(), blender::ed::object::objects_add_active_exec(), and blender::ed::object::objects_remove_active_exec().

◆ FOREACH_COLLECTION_OBJECT_RECURSIVE_BEGIN

#define FOREACH_COLLECTION_OBJECT_RECURSIVE_BEGIN	(		_collection,
			_object )

Value:

  for (Base *_base = static_cast<Base *>(BKE_collection_object_cache_get(_collection).first); \
       _base; \
       _base = _base->next) \
  { \
    Object *_object = _base->object; \
    BLI_assert(_object != NULL);

Definition at line 359 of file BKE_collection.hh.

Referenced by add_collision_object(), BKE_rigidbody_free_world(), BMD_error_messages(), blender::deg::DepsgraphNodeBuilder::build_rigidbody(), blender::deg::DepsgraphRelationBuilder::build_rigidbody(), collection_object_cyclic_check_internal(), DEG_add_collection_geometry_customdata_mask(), blender::bke::Instances::ensure_geometry_instances(), foreach_object_ptcache(), blender::bke::Instances::foreach_referenced_geometry(), blender::ed::outliner::id_override_library_create_hierarchy_pre_process(), blender::ed::object::make_override_library_exec(), modify_mesh(), particle_settings_blend_write(), and psys_check_group_weights().

◆ FOREACH_COLLECTION_OBJECT_RECURSIVE_END

#define FOREACH_COLLECTION_OBJECT_RECURSIVE_END

Value:

} \

((void)0)

Definition at line 367 of file BKE_collection.hh.

Referenced by add_collision_object(), BKE_rigidbody_free_world(), BMD_error_messages(), blender::deg::DepsgraphNodeBuilder::build_rigidbody(), blender::deg::DepsgraphRelationBuilder::build_rigidbody(), collection_object_cyclic_check_internal(), DEG_add_collection_geometry_customdata_mask(), blender::bke::Instances::ensure_geometry_instances(), foreach_object_ptcache(), blender::bke::Instances::foreach_referenced_geometry(), blender::ed::outliner::id_override_library_create_hierarchy_pre_process(), blender::ed::object::make_override_library_exec(), modify_mesh(), particle_settings_blend_write(), and psys_check_group_weights().

◆ FOREACH_COLLECTION_VISIBLE_OBJECT_RECURSIVE_BEGIN

#define FOREACH_COLLECTION_VISIBLE_OBJECT_RECURSIVE_BEGIN	(	_collection,
		_object,
		_mode )

Value:

  { \
    int _base_flag = (_mode == DAG_EVAL_VIEWPORT) ? BASE_ENABLED_VIEWPORT : BASE_ENABLED_RENDER; \
    int _object_visibility_flag = (_mode == DAG_EVAL_VIEWPORT) ? OB_HIDE_VIEWPORT : \
                                                                 OB_HIDE_RENDER; \
    int _base_id = 0; \
    for (Base *_base = static_cast<Base *>(BKE_collection_object_cache_get(_collection).first); \
         _base; \
         _base = _base->next, _base_id++) \
    { \
      Object *_object = _base->object; \
      if ((_base->flag & _base_flag) && \
          (_object->visibility_flag & _object_visibility_flag) == 0) {

Definition at line 339 of file BKE_collection.hh.

Referenced by blender::add_this_collection(), blender::deg::DepsgraphRelationBuilder::build_object_instance_collection(), make_child_duplis(), make_duplis_collection(), make_duplis_geometry_set_impl(), and make_duplis_particle_system().

◆ FOREACH_COLLECTION_VISIBLE_OBJECT_RECURSIVE_END

#define FOREACH_COLLECTION_VISIBLE_OBJECT_RECURSIVE_END

Value:

  } \
  } \
  } \
  ((void)0)

Definition at line 353 of file BKE_collection.hh.

Referenced by blender::add_this_collection(), blender::deg::DepsgraphRelationBuilder::build_object_instance_collection(), make_child_duplis(), make_duplis_collection(), make_duplis_geometry_set_impl(), and make_duplis_particle_system().

◆ FOREACH_SCENE_COLLECTION_BEGIN

#define FOREACH_SCENE_COLLECTION_BEGIN	(		scene,
			_instance )

Value:

  ITER_BEGIN (BKE_scene_collections_iterator_begin, \
              BKE_scene_collections_iterator_next, \
              BKE_scene_collections_iterator_end, \
              scene, \
              Collection *, \
              _instance)

Definition at line 409 of file BKE_collection.hh.

Referenced by BKE_collection_add_from_collection(), BKE_collection_add_from_object(), BKE_collection_object_add_from(), scene_collections_object_remove(), and blender::ed::outliner::unlink_object_fn().

◆ FOREACH_SCENE_COLLECTION_END

#define FOREACH_SCENE_COLLECTION_END ITER_END

Definition at line 417 of file BKE_collection.hh.

Referenced by BKE_collection_add_from_collection(), BKE_collection_add_from_object(), BKE_collection_object_add_from(), scene_collections_object_remove(), and blender::ed::outliner::unlink_object_fn().

◆ FOREACH_SCENE_OBJECT_BEGIN

#define FOREACH_SCENE_OBJECT_BEGIN	(		scene,
			_instance )

Value:

  ITER_BEGIN (BKE_scene_objects_iterator_begin, \
              BKE_scene_objects_iterator_next, \
              BKE_scene_objects_iterator_end, \
              scene, \
              Object *, \
              _instance)

Definition at line 446 of file BKE_collection.hh.

Referenced by BKE_lib_override_library_main_proxy_convert(), BKE_view_layer_rename_lightgroup(), blender::ed::outliner::TreeElementSceneObjectsBase::expand(), get_camera_with_movieclip(), get_used_lightgroups(), id_search_cb_objects_from_scene(), blender::ed::object::object_convert_exec(), blender::ed::object::object_single_user_make(), ptcache_free_bake_all_exec(), blender::bke::bake::scene_simulation_states_reset(), and blender::ed::object::single_obdata_user_make().

◆ FOREACH_SCENE_OBJECT_END

#define FOREACH_SCENE_OBJECT_END ITER_END

Definition at line 454 of file BKE_collection.hh.

Referenced by BKE_lib_override_library_main_proxy_convert(), BKE_view_layer_rename_lightgroup(), blender::ed::outliner::TreeElementSceneObjectsBase::expand(), get_camera_with_movieclip(), get_used_lightgroups(), id_search_cb_objects_from_scene(), blender::ed::object::object_convert_exec(), blender::ed::object::object_single_user_make(), ptcache_free_bake_all_exec(), blender::bke::bake::scene_simulation_states_reset(), and blender::ed::object::single_obdata_user_make().

Typedef Documentation

◆ BKE_scene_collections_Cb

using BKE_scene_collections_Cb = void (*)(Collection *ob, void *data)

Definition at line 335 of file BKE_collection.hh.

◆ BKE_scene_objects_Cb

using BKE_scene_objects_Cb = void (*)(Object *ob, void *data)

Definition at line 334 of file BKE_collection.hh.

Function Documentation

◆ BKE_collection_add()

Collection * BKE_collection_add	(	Main *	bmain,
		Collection *	collection_parent,
		const char *	name_custom )

Add a collection to a collection ListBase and synchronize all render layers The ListBase is NULL when the collection is to be added to the master collection

Definition at line 447 of file collection.cc.

References BKE_main_collection_sync(), and collection_add().

Referenced by BKE_lib_override_library_main_resync(), BKE_light_linking_collection_new(), blender::ed::object::collection_add_exec(), blender::ed::object::collection_create_exec(), blender::ed::outliner::collection_new_exec(), blender::io::usd::create_collection(), do_version_layers_to_collections(), do_versions_after_linking_280(), ED_rigidbody_constraint_add(), blender::io::obj::find_or_create_collection(), blender::io::usd::import_startjob(), loose_data_instantiate_ensure_active_collection(), and blender::ed::object::move_to_collection_exec().

◆ BKE_collection_add_from_collection()

void BKE_collection_add_from_collection	(	Main *	bmain,
		Scene *	scene,
		Collection *	collection_src,
		Collection *	collection_dst )

Add collection_dst to all scene collections that reference collection collection_src is in.

Logic is very similar to BKE_collection_object_add_from().

Definition at line 478 of file collection.cc.

References BKE_collection_child_find(), BKE_main_collection_sync(), collection_child_add(), FOREACH_SCENE_COLLECTION_BEGIN, FOREACH_SCENE_COLLECTION_END, ID_IS_EDITABLE, and ID_IS_OVERRIDE_LIBRARY.

Referenced by lib_override_library_create_post_process().

◆ BKE_collection_add_from_object()

void BKE_collection_add_from_object	(	Main *	bmain,
		Scene *	scene,
		const Object *	ob_src,
		Collection *	collection_dst )

Add collection_dst to all scene collections that reference object ob_src is in. Used to replace an instance object with a collection (library override operator).

Logic is very similar to BKE_collection_object_add_from().

Definition at line 454 of file collection.cc.

References BKE_collection_has_object(), BKE_main_collection_sync(), collection_child_add(), FOREACH_SCENE_COLLECTION_BEGIN, FOREACH_SCENE_COLLECTION_END, ID_IS_LINKED, and ID_IS_OVERRIDABLE_LIBRARY.

Referenced by lib_override_library_create_post_process().

◆ BKE_collection_blend_read_data()

void BKE_collection_blend_read_data	(	BlendDataReader *	reader,
		Collection *	collection,
		ID *	owner_id )

Definition at line 311 of file collection.cc.

References BKE_previewimg_blend_read(), BLI_assert, BLO_read_fileversion_get(), BLO_read_struct, BLO_read_struct_list, CLOG_WARN, Library::id, ID_FLAG_EMBEDDED_DATA, IDP_BlendDataRead, ID::lib, LISTBASE_FOREACH, LOG, and ID::name.

Referenced by collection_blend_read_data(), and direct_link_id_embedded_id().

◆ BKE_collection_blend_write_nolib()

void BKE_collection_blend_write_nolib	(	BlendWriter *	writer,
		Collection *	collection )

Definition at line 276 of file collection.cc.

References BKE_id_blend_write(), BKE_previewimg_blend_write(), BLO_write_struct, IDP_BlendWrite(), and LISTBASE_FOREACH.

Referenced by collection_blend_write(), and scene_blend_write().

◆ BKE_collection_blend_write_prepare_nolib()

void BKE_collection_blend_write_prepare_nolib	(	BlendWriter *	writer,
		Collection *	collection )

Perform some pre-writing cleanup on the COllection data itself (not in any sub-data referenced by pointers). To be called before writing the Collection struct itself.

Definition at line 269 of file collection.cc.

Referenced by collection_blend_write(), and scene_blend_write().

◆ BKE_collection_child_add()

bool BKE_collection_child_add	(	Main *	bmain,
		Collection *	parent,
		Collection *	child )

Definition at line 1912 of file collection.cc.

References BKE_main_collection_sync(), and collection_child_add().

Referenced by blender::ed::outliner::collection_link_exec(), light_linking_collection_add_collection(), loose_data_instantiate_collection_process(), and ui_template_id_liboverride_hierarchy_make().

◆ BKE_collection_child_add_no_sync()

bool BKE_collection_child_add_no_sync	(	Main *	bmain,
		Collection *	parent,
		Collection *	child )

Definition at line 1922 of file collection.cc.

References collection_child_add().

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

◆ BKE_collection_child_find()

CollectionChild * BKE_collection_child_find	(	Collection *	parent,
		Collection *	collection )

Definition at line 1820 of file collection.cc.

References BLI_findptr(), Collection::children, and offsetof.

Referenced by BKE_collection_add_from_collection(), BKE_collection_move(), BKE_collection_parent_relations_rebuild(), BKE_collections_child_remove_nulls(), collection_child_add(), collection_child_remove(), blender::ed::outliner::collection_duplicate_exec(), collection_duplicate_recursive(), and collection_missing_parents_remove().

◆ BKE_collection_child_remove()

bool BKE_collection_child_remove	(	Main *	bmain,
		Collection *	parent,
		Collection *	child )

Definition at line 1927 of file collection.cc.

References BKE_main_collection_sync(), and collection_child_remove().

Referenced by BKE_light_linking_unlink_id_from_collection(), collection_cycle_fix_recursive(), blender::ed::object::collection_drop_exec(), blender::ed::object::make_override_library_exec(), and blender::ed::outliner::unlink_collection_fn().

◆ BKE_collection_cycle_find()

bool BKE_collection_cycle_find	(	Collection *	new_ancestor,
		Collection *	collection )

Find potential cycles in collections.

Parameters

new_ancestor	the potential new owner of given collection, or the collection to check if the later is NULL.
collection	the collection we want to add to new_ancestor, may be NULL if we just want to ensure new_ancestor does not already have cycles.

Returns: true if a cycle is found.

Definition at line 1750 of file collection.cc.

References BKE_collection_cycle_find(), collection_instance_find_recursive(), LISTBASE_FOREACH, Collection_Runtime::parents, and Collection::runtime.

Referenced by BKE_collection_cycle_find(), BKE_collection_move(), BKE_collection_parent_relations_rebuild(), BKE_collection_validate(), blender::ed::object::collection_add_info_get_from_op(), collection_child_add(), collection_cycle_fix_recursive(), and blender::ed::outliner::collection_instance_exec().

◆ BKE_collection_cycles_fix()

bool BKE_collection_cycles_fix	(	Main *	bmain,
		Collection *	collection )

Find and fix potential cycles in collections.

Parameters

collection The collection to check for existing cycles.

Returns: true if cycles are found and fixed.

Definition at line 1814 of file collection.cc.

References collection_cycle_fix_recursive(), and collection_instance_fix_recursive().

Referenced by do_versions_after_linking_290().

◆ BKE_collection_delete()

bool BKE_collection_delete	(	Main *	bmain,
		Collection *	collection,
		bool	hierarchy )

Remove a collection, optionally removing its child objects or moving them to parent collections.

Definition at line 540 of file collection.cc.

References BKE_collection_delete(), BKE_id_delete(), BKE_main_collection_sync(), BLI_assert_msg, BLI_ghash_free(), CollectionChild::collection, collection_child_add(), COLLECTION_IS_MASTER, collection_object_add(), collection_object_remove_no_gobject_hash(), LIB_ID_CREATE_NO_DEG_TAG, LISTBASE_FOREACH, and CollectionObject::ob.

Referenced by BKE_collection_delete(), BKE_lib_override_library_main_resync(), and blender::ed::outliner::outliner_collection_delete().

◆ BKE_collection_duplicate()

Collection * BKE_collection_duplicate	(	Main *	bmain,
		Collection *	parent,
		CollectionChild *	child_old,
		Collection *	collection,
		uint	duplicate_flags,
		uint	duplicate_options )

Make a deep copy (aka duplicate) of the given collection and all of its children, recursively.

Warning: This functions will clear all bmain #ID.idnew pointers, unless LIB_ID_DUPLICATE_IS_SUBPROCESS duplicate option is passed on, in which case caller is responsible to reconstruct collection dependencies information's (i.e. call BKE_main_collection_sync).

Definition at line 727 of file collection.cc.

References BKE_libblock_relink_to_newid(), BKE_main_collection_sync(), BKE_main_id_newptr_and_tag_clear(), BLI_assert, collection_duplicate_recursive(), FOREACH_MAIN_ID_BEGIN, FOREACH_MAIN_ID_END, Collection::id, ID_IS_LINKED, ID_TAG_NEW, ID_TAG_NO_MAIN, LIB_ID_CREATE_NO_MAIN, LIB_ID_DUPLICATE_IS_ROOT_ID, LIB_ID_DUPLICATE_IS_SUBPROCESS, ID::tag, and USER_DUP_LINKED_ID.

Referenced by BKE_scene_duplicate(), and blender::ed::outliner::collection_duplicate_exec().

◆ BKE_collection_exporter_free_data()

void BKE_collection_exporter_free_data ( CollectionExport * data )

Free all data owned by the collection exporter.

Definition at line 533 of file collection.cc.

References IDP_FreeProperty().

Referenced by blender::ed::object::collection_exporter_remove_exec(), and collection_free_data().

◆ BKE_collection_exporter_name_set()

void BKE_collection_exporter_name_set	(	const ListBase *	exporters,
		CollectionExport *	data,
		const char *	newname )

Assigns a unique name to the collection exporter.

Definition at line 519 of file collection.cc.

References BLI_listbase_from_link(), BLI_uniquename(), offsetof, and STRNCPY.

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

◆ BKE_collection_free_data()

void BKE_collection_free_data ( Collection * collection )

Free (or release) any data used by this collection (does not free the collection itself).

Definition at line 513 of file collection.cc.

References BKE_libblock_free_data(), and collection_free_data().

Referenced by scene_free_data().

◆ BKE_collection_from_index()

Collection * BKE_collection_from_index	(	Scene *	scene,
		int	index )

Return Scene Collection for a given index.

The index is calculated from top to bottom counting the children before the siblings.

Definition at line 2087 of file collection.cc.

References collection_from_index_recursive().

Referenced by blender::ed::object::move_to_collection_exec(), and blender::ed::object::move_to_collection_invoke().

◆ BKE_collection_has_collection()

bool BKE_collection_has_collection	(	const Collection *	parent,
		const Collection *	collection )

Definition at line 1841 of file collection.cc.

References collection_find_child_recursive().

Referenced by lib_override_library_create_post_process(), blender::ed::object::make_override_library_invoke(), blender::ed::outliner::outliner_collection_is_isolated(), template_id_liboverride_hierarchy_collections_tag_recursive(), and ui_template_id_liboverride_hierarchy_make().

◆ BKE_collection_has_object()

bool BKE_collection_has_object	(	Collection *	collection,
		const Object *	ob )

Definition at line 1055 of file collection.cc.

References BLI_ghash_lookup(), collection_gobject_hash_ensure(), and ELEM.

◆ BKE_collection_has_object_recursive()

bool BKE_collection_has_object_recursive	(	Collection *	collection,
		Object *	ob )

Definition at line 1064 of file collection.cc.

References BKE_collection_object_cache_get(), BLI_findptr(), ELEM, and offsetof.

Referenced by animdata_filter_base_is_ok(), animdata_filter_grease_pencil(), BKE_object_scenes_users_get(), blender::ed::outliner::can_select_recursive(), ED_editors_init(), blender::ed::object::make_override_library_invoke(), object_in_any_scene(), psys_check_group_weights(), blender::ed::object::select_grouped_exec(), template_id_liboverride_hierarchy_collections_tag_recursive(), and ui_template_id_liboverride_hierarchy_make().

◆ BKE_collection_has_object_recursive_instanced()

bool BKE_collection_has_object_recursive_instanced	(	Collection *	collection,
		Object *	ob )

Definition at line 1074 of file collection.cc.

References BKE_collection_object_cache_instanced_get(), BLI_findptr(), ELEM, and offsetof.

Referenced by MOD_lineart_gpencil_generate_v3().

◆ BKE_collection_has_object_recursive_instanced_orig_id()

bool BKE_collection_has_object_recursive_instanced_orig_id	(	Collection *	collection_eval,
		Object *	object_eval )

Find whether an evaluated object's original ID is contained or instanced by any object in this collection. The collection is expected to be an evaluated data-block too.

Definition at line 1084 of file collection.cc.

References BKE_collection_object_cache_instanced_get(), BLI_assert, DEG_get_original_id(), Collection::id, Object::id, ID_TAG_COPIED_ON_EVAL, LISTBASE_FOREACH, and ID::tag.

Referenced by blender::nodes::node_geo_collection_info_cc::node_geo_exec().

◆ BKE_collection_is_empty()

bool BKE_collection_is_empty ( const Collection * collection )

Definition at line 1131 of file collection.cc.

References BLI_listbase_is_empty().

Referenced by BKE_lib_override_library_main_resync(), BMD_error_messages(), and blender::ed::outliner::collection_drop_invoke().

◆ BKE_collection_is_in_scene()

bool BKE_collection_is_in_scene ( Collection * collection )

Definition at line 1698 of file collection.cc.

References BKE_collection_is_in_scene(), COLLECTION_IS_MASTER, and LISTBASE_FOREACH.

Referenced by BKE_collection_is_in_scene(), BKE_collection_object_add_notest(), BKE_collection_object_remove(), BKE_collection_object_replace(), and lib_override_library_create_post_process().

◆ BKE_collection_master_add()

Collection * BKE_collection_master_add ( Scene * scene )

Definition at line 989 of file collection.cc.

References BKE_libblock_alloc_in_lib(), BKE_SCENE_COLLECTION_NAME, BLI_assert, COLLECTION_COLOR_NONE, COLLECTION_IS_MASTER, Collection::color_tag, Collection::flag, ID::flag, Collection::id, ID_FLAG_EMBEDDED_DATA, ID_GR, ID::lib, LIB_ID_CREATE_NO_MAIN, and Collection::owner_id.

Referenced by do_version_layers_to_collections(), do_versions_after_linking_280(), and scene_init_data().

◆ BKE_collection_move()

bool BKE_collection_move	(	Main *	bmain,
		Collection *	to_parent,
		Collection *	from_parent,
		Collection *	relative,
		bool	relative_after,
		Collection *	collection )

Definition at line 2155 of file collection.cc.

References BKE_collection_child_find(), BKE_collection_cycle_find(), BKE_collection_object_cache_free(), BKE_main_collection_sync(), BLI_insertlinkafter(), BLI_insertlinkbefore(), BLI_remlink(), Collection::children, collection_child_add(), collection_child_remove(), and COLLECTION_IS_MASTER.

Referenced by blender::ed::outliner::collection_drop_invoke().

◆ BKE_collection_new_name_get()

void BKE_collection_new_name_get	(	Collection *	collection_parent,
		char *	rname )

The automatic/fallback name of a new collection.

Definition at line 793 of file collection.cc.

References BLI_listbase_count(), BLI_sprintfN(), BLI_strdup(), BLI_strncpy(), Collection::children, COLLECTION_IS_MASTER, DATA_, Collection::flag, Collection::id, integer_digits_i(), MAX_NAME, MEM_freeN(), and ID::name.

Referenced by collection_add(), and blender::ed::object::move_to_collection_invoke().

◆ BKE_collection_object_add()

bool BKE_collection_object_add	(	Main *	bmain,
		Collection *	collection,
		Object *	ob )

Add object to given collection, ensuring this collection is 'editable' (i.e. local and not a liboverride), and finding a suitable parent one otherwise.

Definition at line 1468 of file collection.cc.

References BKE_collection_viewlayer_object_add().

◆ BKE_collection_object_add_from()

void BKE_collection_object_add_from	(	Main *	bmain,
		Scene *	scene,
		Object *	ob_src,
		Object *	ob_dst )

Add ob_dst to all scene collections that reference object ob_src is in. Used for copying objects.

Logic is very similar to BKE_collection_add_from_object()

Definition at line 1491 of file collection.cc.

References BKE_collection_has_object(), BKE_main_collection_sync(), collection_object_add(), FOREACH_SCENE_COLLECTION_BEGIN, FOREACH_SCENE_COLLECTION_END, ID_IS_EDITABLE, and ID_IS_OVERRIDE_LIBRARY.

Referenced by BKE_object_add_from(), DocumentImporter::create_instance_node(), blender::ed::object::duplibase_for_convert(), lib_override_library_create_post_process(), blender::ed::object::make_object_duplilist_real(), and blender::ed::object::object_add_sync_base_collection().

◆ BKE_collection_object_add_notest()

bool BKE_collection_object_add_notest	(	Main *	bmain,
		Collection *	collection,
		Object *	ob )

Same as BKE_collection_object_add, but unconditionally adds the object to the given collection.

NOTE: required in certain cases, like do-versioning or complex ID management tasks.

Definition at line 1443 of file collection.cc.

References BKE_collection_is_in_scene(), BKE_main_collection_sync(), BLI_assert, collection_object_add(), ID_TAG_NO_MAIN, and LIB_ID_CREATE_NO_MAIN.

Referenced by BKE_collection_viewlayer_object_add(), do_version_layers_to_collections(), and do_versions_after_linking_280().

◆ BKE_collection_object_cache_free()

void BKE_collection_object_cache_free	(	const Main *	bmain,
		Collection *	collection,
		const int	id_create_flag )

Free the object cache of given collection and all of its ancestors (recursively).

Parameters

bmain	The Main database owning the collection. May be `nullptr`, only used if doing depsgraph tagging.
id_create_flag	Flags controlling ID creation, used here to enable or not depsgraph tagging of affected IDs (e.g. LIB_ID_CREATE_NO_DEG_TAG would prevent depsgraph tagging).

Definition at line 946 of file collection.cc.

References BLI_assert, collection_object_cache_free_parent_recursive(), ID_RECALC_GEOMETRY, and ID_RECALC_HIERARCHY.

Referenced by BKE_collection_move(), collection_child_add(), collection_child_remove(), collection_gobject_hash_ensure_fix(), collection_object_add(), collection_object_remove_no_gobject_hash(), and blender::deg::deg_graph_build_finalize().

◆ BKE_collection_object_cache_get()

ListBase BKE_collection_object_cache_get ( Collection * collection )

Definition at line 867 of file collection.cc.

References BLI_MUTEX_INITIALIZER, BLI_mutex_lock(), BLI_mutex_unlock(), COLLECTION_HAS_OBJECT_CACHE, and collection_object_cache_fill().

Referenced by BKE_collection_has_object_recursive(), BKE_collection_or_layer_objects(), make_duplis_particle_system(), and psys_find_group_weights().

◆ BKE_collection_object_cache_instanced_get()

ListBase BKE_collection_object_cache_instanced_get ( Collection * collection )

Definition at line 883 of file collection.cc.

References BLI_MUTEX_INITIALIZER, BLI_mutex_lock(), BLI_mutex_unlock(), COLLECTION_HAS_OBJECT_CACHE_INSTANCED, and collection_object_cache_fill().

Referenced by BKE_collection_has_object_recursive_instanced(), and BKE_collection_has_object_recursive_instanced_orig_id().

◆ BKE_collection_object_cyclic_check()

bool BKE_collection_object_cyclic_check	(	Main *	bmain,
		Object *	object,
		Collection *	collection )

Definition at line 1041 of file collection.cc.

References BKE_main_id_tag_listbase(), collection_object_cyclic_check_internal(), Main::collections, and ID_TAG_DOIT.

Referenced by blender::ed::object::collection_link_exec(), and blender::ed::object::objects_add_active_exec().

◆ BKE_collection_object_find()

Collection * BKE_collection_object_find	(	Main *	bmain,
		Scene *	scene,
		Collection *	collection,
		Object *	ob )

Definition at line 1107 of file collection.cc.

References BKE_collection_has_object(), collection_next_find(), Main::collections, and ListBase::first.

Referenced by BKE_object_groups(), BKE_object_groups_clear(), blender::ed::object::collection_object_active_find_index(), blender::ed::object::collection_object_active_itemf(), and blender::ed::outliner::outliner_collection_get_for_recursive().

◆ BKE_collection_object_move()

void BKE_collection_object_move	(	Main *	bmain,
		Scene *	scene,
		Collection *	collection_dst,
		Collection *	collection_src,
		Object *	ob )

Move object from a collection into another

If source collection is NULL move it from all the existing collections.

Definition at line 1674 of file collection.cc.

References BKE_collection_object_add(), BKE_collection_object_remove(), and scene_collections_object_remove().

Referenced by blender::ed::outliner::collection_drop_invoke(), and blender::ed::object::move_to_collection_exec().

◆ BKE_collection_object_remove()

bool BKE_collection_object_remove	(	Main *	bmain,
		Collection *	collection,
		Object *	ob,
		bool	free_us )

Remove ob from collection.

Definition at line 1514 of file collection.cc.

References BKE_collection_is_in_scene(), BKE_main_collection_sync(), collection_object_remove(), ELEM, ID_TAG_NO_MAIN, and LIB_ID_CREATE_NO_MAIN.

Referenced by BKE_collection_object_move(), BKE_light_linking_unlink_id_from_collection(), BKE_object_groups_clear(), blender::ed::object::collection_objects_remove_exec(), blender::ed::object::collection_remove_exec(), do_versions_after_linking_280(), blender::ed::object::objects_remove_active_exec(), and blender::ed::outliner::unlink_object_fn().

◆ BKE_collection_object_replace()

bool BKE_collection_object_replace	(	Main *	bmain,
		Collection *	collection,
		Object *	ob_old,
		Object *	ob_new )

Replace one object with another in a collection (managing user counts).

Definition at line 1535 of file collection.cc.

References BKE_collection_is_in_scene(), BKE_main_collection_sync(), BLI_ghash_haskey(), BLI_ghash_insert(), BLI_ghash_popkey(), collection_gobject_hash_ensure(), collection_object_remove_no_gobject_hash(), Object::id, id_us_min(), id_us_plus(), and CollectionObject::ob.

◆ BKE_collection_objects_select()

bool BKE_collection_objects_select	(	const Scene *	scene,
		ViewLayer *	view_layer,
		Collection *	collection,
		bool	deselect )

Select all the objects in this Collection (and its nested collections) for this ViewLayer. Return true if any object was selected.

Definition at line 2134 of file collection.cc.

References BKE_layer_collection_first_from_scene_collection(), BKE_layer_collection_objects_select(), and collection_objects_select().

◆ BKE_collection_or_layer_objects()

Base * BKE_collection_or_layer_objects	(	const Scene *	scene,
		ViewLayer *	view_layer,
		Collection *	collection )

Definition at line 972 of file collection.cc.

References BKE_collection_object_cache_get(), BKE_view_layer_object_bases_get(), BKE_view_layer_synced_ensure(), and ListBase::first.

Referenced by BKE_collision_relations_create(), BKE_effector_relations_create(), and blender::deg::FromCollectionBuilderPipeline::FromCollectionBuilderPipeline().

◆ BKE_collection_parent_editable_find_recursive()

Collection * BKE_collection_parent_editable_find_recursive	(	const ViewLayer *	view_layer,
		Collection *	collection )

Return parent collection which is not linked.

Definition at line 1313 of file collection.cc.

References BKE_collection_parent_editable_find_recursive(), BKE_view_layer_has_collection(), COLLECTION_IS_MASTER, ID_IS_EDITABLE, ID_IS_LINKED, ID_IS_OVERRIDE_LIBRARY, and LISTBASE_FOREACH.

Referenced by BKE_collection_parent_editable_find_recursive(), BKE_collection_viewlayer_object_add(), and loose_data_instantiate_ensure_active_collection().

◆ BKE_collection_parent_relations_rebuild()

void BKE_collection_parent_relations_rebuild ( Collection * collection )

Rebuild parent relationships from child ones, for all children of given collection.

Note: Given collection is assumed to already have valid parents.

Definition at line 1937 of file collection.cc.

References BKE_collection_child_find(), BKE_collection_cycle_find(), BLI_addtail(), BLI_assert, BLI_freelinkN(), CollectionParent::collection, collection_find_parent(), ID_TAG_COPIED_ON_EVAL, ID_TAG_NO_MAIN, LISTBASE_FOREACH_MUTABLE, and MEM_callocN.

Referenced by collection_parents_rebuild_recursive().

◆ BKE_collection_ui_name_get()

const char * BKE_collection_ui_name_get ( Collection * collection )

The name to show in the interface.

Definition at line 816 of file collection.cc.

References COLLECTION_IS_MASTER, and IFACE_.

Referenced by draw_selected_name(), get_stats_string(), blender::ed::object::move_to_collection_exec(), blender::ed::object::move_to_collection_menu_create(), and blender::ed::outliner::outliner_add_collection_init().

◆ BKE_collection_validate()

bool BKE_collection_validate ( Collection * collection )

Perform some validation on integrity of the data of this collection.

Returns: true if everything is OK, false if some errors are detected.

Definition at line 2020 of file collection.cc.

References BKE_collection_cycle_find(), BLI_gset_clear(), BLI_gset_ensure_p_ex(), BLI_gset_free(), BLI_gset_ptr_new(), BLI_listbase_validate(), and LISTBASE_FOREACH.

◆ BKE_collection_viewlayer_object_add()

bool BKE_collection_viewlayer_object_add	(	Main *	bmain,
		const ViewLayer *	view_layer,
		Collection *	collection,
		Object *	ob )

Add object to given collection, similar to BKE_collection_object_add.

However, it additionally ensures that the selected collection is also part of the given view_layer, if non-NULL. Otherwise, the object is not added to any collection.

Definition at line 1473 of file collection.cc.

References BKE_collection_object_add_notest(), and BKE_collection_parent_editable_find_recursive().

Referenced by BKE_collection_object_add(), and BKE_object_add().

◆ BKE_collections_after_lib_link()

void BKE_collections_after_lib_link ( Main * bmain )

Definition at line 1713 of file collection.cc.

References BKE_main_collection_sync().

Referenced by blo_read_file_internal(), and library_link_end().

◆ BKE_collections_child_remove_nulls()

void BKE_collections_child_remove_nulls	(	Main *	bmain,
		Collection *	parent_collection,
		Collection *	child_collection )

Remove all NULL children from parent collections of changed collection. This is used for library remapping, where these pointers have been set to NULL. Otherwise this should never happen.

Note: caller must ensure BKE_main_collection_sync_remap() is called afterwards!

Parameters

parent_collection	The collection owning the pointers that were remapped. May be NULL, in which case whole bmain database of collections is checked.
child_collection	The collection that was remapped to another pointer. May be NULL, in which case whole bmain database of collections is checked.

Definition at line 1635 of file collection.cc.

References BKE_collection_child_find(), BLI_freelinkN(), collection_missing_parents_remove(), collection_null_children_remove(), Main::collections, LISTBASE_FOREACH, LISTBASE_FOREACH_MUTABLE, Collection_Runtime::parents, Collection::runtime, and Main::scenes.

Referenced by libblock_remap_data_postprocess_collection_update().

◆ BKE_collections_object_remove_invalids()

void BKE_collections_object_remove_invalids ( Main * bmain )

Check all collections in bmain (including embedded ones in scenes) for invalid CollectionObject (either with NULL object pointer, or duplicates), and remove them.