#include <BKE_instances.hh>

Public Member Functions
	Instances ()

	Instances (Instances &&other)

	Instances (const Instances &other)

	~Instances ()

Instances &	operator= (const Instances &other)

Instances &	operator= (Instances &&other)

void	resize (int capacity)

int	add_reference (const InstanceReference &reference)

int	add_new_reference (const InstanceReference &reference)

std::optional< int >	find_reference_handle (const InstanceReference &query)

void	add_instance (int instance_handle, const float4x4 &transform)

Span< InstanceReference >	references () const

void	remove_unused_references ()

void	ensure_geometry_instances ()

GeometrySet &	geometry_set_from_reference (int reference_index)

Span< int >	reference_handles () const

MutableSpan< int >	reference_handles_for_write ()

Span< float4x4 >	transforms () const

MutableSpan< float4x4 >	transforms_for_write ()

int	instances_num () const

int	references_num () const

void	remove (const IndexMask &mask, const AttributeFilter &attribute_filter)

Span< int >	almost_unique_ids () const

Span< int >	reference_user_counts () const

void	foreach_referenced_geometry (FunctionRef< void(const GeometrySet &geometry_set)> callback) const

bool	owns_direct_data () const

void	ensure_owns_direct_data ()

void	count_memory (MemoryCounter &memory) const

void	tag_reference_handles_changed ()

Geometry Component Implementation
bke::AttributeAccessor	attributes () const

bke::MutableAttributeAccessor	attributes_for_write ()

#InstanceReference Inline Methods
CustomData &	custom_data_attributes ()

const CustomData &	custom_data_attributes () const

Detailed Description

Definition at line 112 of file BKE_instances.hh.

Constructor & Destructor Documentation

◆ Instances() [1/3]

blender::bke::Instances::Instances ( )

Definition at line 140 of file instances.cc.

References CustomData_reset().

Referenced by operator=(), and operator=().

◆ Instances() [2/3]

blender::bke::Instances::Instances ( Instances && other )

Definition at line 145 of file instances.cc.

References CustomData_reset().

◆ Instances() [3/3]

blender::bke::Instances::Instances ( const Instances & other )

Definition at line 155 of file instances.cc.

References CD_MASK_ALL, and CustomData_init_from().

◆ ~Instances()

blender::bke::Instances::~Instances ( )

Definition at line 164 of file instances.cc.

References CustomData_free().

Member Function Documentation

◆ add_instance()

void blender::bke::Instances::add_instance	(	int	instance_handle,
		const float4x4 &	transform )

Add a reference to the instance reference with an index specified by the #instance_handle argument. For adding many instances, using resize and accessing the transform array directly is preferred.

Definition at line 195 of file instances.cc.

References BLI_assert, CustomData_realloc(), blender::MutableSpan< T >::last(), reference_handles_for_write(), tag_reference_handles_changed(), transform(), and transforms_for_write().

◆ add_new_reference()

int blender::bke::Instances::add_new_reference ( const InstanceReference & reference )

Same as above, but does not deduplicate with existing references.

Definition at line 271 of file instances.cc.

References tag_reference_handles_changed().

Referenced by add_reference().

◆ add_reference()

int blender::bke::Instances::add_reference ( const InstanceReference & reference )

Returns a handle for the given reference. If the reference exists already, the handle of the existing reference is returned. Otherwise a new handle is added.

Definition at line 263 of file instances.cc.

References add_new_reference(), and find_reference_handle().

Referenced by blender::nodes::node_geo_instance_on_points_cc::add_instances_from_component(), and blender::nodes::node_geo_split_to_instances_cc::node_geo_exec().

◆ almost_unique_ids()

Span< int > blender::bke::Instances::almost_unique_ids ( ) const

Get an id for every instance. These can be used for e.g. motion blur.

Definition at line 497 of file instances.cc.

References blender::Array< T, InlineBufferCapacity, Allocator >::as_mutable_span(), attributes(), blender::array_utils::fill_index_range(), blender::bke::generate_unique_instance_ids(), blender::bke::AttributeAccessor::lookup(), blender::Array< T, InlineBufferCapacity, Allocator >::reinitialize(), blender::Array< T, InlineBufferCapacity, Allocator >::size(), blender::Span< T >::size(), and blender::bke::AttributeReader< T >::varray.

◆ attributes()

AttributeAccessor blender::bke::Instances::attributes ( ) const

Definition at line 215 of file geometry_component_instances.cc.

References blender::bke::get_instances_accessor_functions_ref().

Referenced by almost_unique_ids(), blender::nodes::node_geo_duplicate_elements_cc::duplicate_instances(), remove(), and blender::geometry::reorder_instaces_exec().

◆ attributes_for_write()

MutableAttributeAccessor blender::bke::Instances::attributes_for_write ( )

Definition at line 220 of file geometry_component_instances.cc.

References blender::bke::get_instances_accessor_functions_ref().

Referenced by blender::nodes::node_geo_instance_on_points_cc::add_instances_from_component(), blender::nodes::node_geo_split_to_instances_cc::node_geo_exec(), remove(), blender::geometry::reorder_instaces(), and blender::geometry::reorder_instaces_exec().

◆ count_memory()

void blender::bke::Instances::count_memory ( MemoryCounter & memory ) const

Definition at line 420 of file instances.cc.

References CustomData_count_memory().

Referenced by blender::bke::InstancesComponent::count_memory().

◆ custom_data_attributes() [1/2]

CustomData & blender::bke::Instances::custom_data_attributes ( )

inline

Definition at line 307 of file BKE_instances.hh.

Referenced by blender::bke::create_attribute_providers_for_instances().

◆ custom_data_attributes() [2/2]

const CustomData & blender::bke::Instances::custom_data_attributes ( ) const

inline

Definition at line 312 of file BKE_instances.hh.

◆ ensure_geometry_instances()

void blender::bke::Instances::ensure_geometry_instances ( )

If references have a collection or object type, convert them into geometry instances recursively. After that, the geometry sets can be edited. There may still be instances of other types of they can't be converted to geometry sets.

Definition at line 104 of file geometry_set_instances.cc.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append(), blender::bke::InstanceReference::Collection, ELEM, ensure_geometry_instances(), FOREACH_COLLECTION_OBJECT_RECURSIVE_BEGIN, FOREACH_COLLECTION_OBJECT_RECURSIVE_END, blender::bke::GeometrySet::from_instances(), blender::bke::InstanceReference::GeometrySet, blender::bke::GeometrySet::get_instances_for_write(), blender::bke::GeometrySet::has_instances(), blender::bke::InstanceReference::None, OB_ARMATURE, OB_CAMERA, OB_GPENCIL_LEGACY, OB_LAMP, OB_SPEAKER, blender::bke::InstanceReference::Object, blender::bke::object_get_evaluated_geometry_set(), blender::Vector< T, InlineBufferCapacity, Allocator >::reserve(), and transforms().

Referenced by ensure_geometry_instances(), and blender::bke::gather_mutable_geometry_sets().

◆ ensure_owns_direct_data()

void blender::bke::Instances::ensure_owns_direct_data ( )

Definition at line 410 of file instances.cc.

References blender::bke::InstanceReference::ensure_owns_direct_data().

Referenced by blender::bke::InstancesComponent::ensure_owns_direct_data().

◆ find_reference_handle()

std::optional< int > blender::bke::Instances::find_reference_handle ( const InstanceReference & query )

Definition at line 252 of file instances.cc.

Referenced by add_reference().

◆ foreach_referenced_geometry()

void blender::bke::Instances::foreach_referenced_geometry ( FunctionRef< void(const GeometrySet &geometry_set)> callback ) const

Definition at line 72 of file geometry_set_instances.cc.

References callback, blender::bke::InstanceReference::Collection, FOREACH_COLLECTION_OBJECT_RECURSIVE_BEGIN, FOREACH_COLLECTION_OBJECT_RECURSIVE_END, blender::bke::InstanceReference::GeometrySet, blender::bke::InstanceReference::None, blender::bke::InstanceReference::Object, and blender::bke::object_get_evaluated_geometry_set().

Referenced by blender::bke::GeometrySet::attribute_foreach(), and blender::bke::gather_component_types_recursive().

◆ geometry_set_from_reference()

GeometrySet & blender::bke::Instances::geometry_set_from_reference ( int reference_index )

With write access to the instances component, the data in the instanced geometry sets can be changed. This is a function on the component rather than each reference to ensure const correctness for that reason.

Definition at line 243 of file instances.cc.

References BLI_assert, and blender::bke::InstanceReference::GeometrySet.