#include <BKE_geometry_set.hh>

Public Types
using	AttributeForeachCallback

using	ForeachSubGeometryCallback = FunctionRef<void(GeometrySet &geometry_set)>

Public Member Functions
template<typename Component >
Component &	get_component_for_write ()

template<typename Component >
const Component *	get_component () const

template<typename Component >
bool	has () const

template<typename Component >
bool	has_component () const

template<typename Component >
void	remove ()

uint64_t	hash () const

Public Attributes
std::string	name

Friends
std::ostream &	operator<< (std::ostream &stream, const GeometrySet &geometry_set)

bool	operator== (const GeometrySet &a, const GeometrySet &b)

Geometry Set
	GeometrySet ()

	GeometrySet (const GeometrySet &other)

	GeometrySet (GeometrySet &&other)

	~GeometrySet ()

GeometrySet &	operator= (const GeometrySet &other)

GeometrySet &	operator= (GeometrySet &&other)

GeometryComponent &	get_component_for_write (GeometryComponent::Type component_type)

const GeometryComponent *	get_component (GeometryComponent::Type component_type) const

bool	has (const GeometryComponent::Type component_type) const

void	remove (const GeometryComponent::Type component_type)

void	keep_only (Span< GeometryComponent::Type > component_types)

void	keep_only_during_modify (Span< GeometryComponent::Type > component_types)

void	remove_geometry_during_modify ()

void	add (const GeometryComponent &component)

Vector< const GeometryComponent * >	get_components () const

std::optional< Bounds< float3 > >	compute_boundbox_without_instances () const

void	clear ()

bool	owns_direct_data () const

void	ensure_owns_direct_data ()

void	ensure_owns_all_data ()

void	attribute_foreach (Span< GeometryComponent::Type > component_types, bool include_instances, AttributeForeachCallback callback) const

void	gather_attributes_for_propagation (Span< GeometryComponent::Type > component_types, GeometryComponent::Type dst_component_type, bool include_instances, const AttributeFilter &attribute_filter, Map< StringRef, AttributeKind > &r_attributes) const

Vector< GeometryComponent::Type >	gather_component_types (bool include_instances, bool ignore_empty) const

void	modify_geometry_sets (ForeachSubGeometryCallback callback)

bool	has_mesh () const

bool	has_pointcloud () const

bool	has_instances () const

bool	has_volume () const

bool	has_curves () const

bool	has_realized_data () const

bool	has_grease_pencil () const

bool	is_empty () const

const Mesh *	get_mesh () const

const PointCloud *	get_pointcloud () const

const Volume *	get_volume () const

const Curves *	get_curves () const

const Instances *	get_instances () const

const CurvesEditHints *	get_curve_edit_hints () const

const GizmoEditHints *	get_gizmo_edit_hints () const

const GreasePencil *	get_grease_pencil () const

Mesh *	get_mesh_for_write ()

PointCloud *	get_pointcloud_for_write ()

Volume *	get_volume_for_write ()

Curves *	get_curves_for_write ()

Instances *	get_instances_for_write ()

CurvesEditHints *	get_curve_edit_hints_for_write ()

GizmoEditHints *	get_gizmo_edit_hints_for_write ()

GreasePencil *	get_grease_pencil_for_write ()

void	replace_mesh (Mesh *mesh, GeometryOwnershipType ownership=GeometryOwnershipType::Owned)

void	replace_pointcloud (PointCloud *pointcloud, GeometryOwnershipType ownership=GeometryOwnershipType::Owned)

void	replace_volume (Volume *volume, GeometryOwnershipType ownership=GeometryOwnershipType::Owned)

void	replace_curves (Curves *curves, GeometryOwnershipType ownership=GeometryOwnershipType::Owned)

void	replace_instances (Instances *instances, GeometryOwnershipType ownership=GeometryOwnershipType::Owned)

void	replace_grease_pencil (GreasePencil *grease_pencil, GeometryOwnershipType ownership=GeometryOwnershipType::Owned)

void	count_memory (MemoryCounter &memory) const

static void	propagate_attributes_from_layer_to_instances (const AttributeAccessor src_attributes, MutableAttributeAccessor dst_attributes, const AttributeFilter &attribute_filter)

static GeometrySet	from_mesh (Mesh *mesh, GeometryOwnershipType ownership=GeometryOwnershipType::Owned)

static GeometrySet	from_volume (Volume *volume, GeometryOwnershipType ownership=GeometryOwnershipType::Owned)

static GeometrySet	from_pointcloud (PointCloud *pointcloud, GeometryOwnershipType ownership=GeometryOwnershipType::Owned)

static GeometrySet	from_curves (Curves *curves, GeometryOwnershipType ownership=GeometryOwnershipType::Owned)

static GeometrySet	from_instances (Instances *instances, GeometryOwnershipType ownership=GeometryOwnershipType::Owned)

static GeometrySet	from_grease_pencil (GreasePencil *grease_pencil, GeometryOwnershipType ownership=GeometryOwnershipType::Owned)

Detailed Description

A geometry set is a container for multiple kinds of geometry. It does not own geometry directly itself, instead geometry is owned by multiple #GeometryComponents, and the geometry set increases the user count of each component, so they avoid losing the data. This means individual components might be shared between multiple geometries and other code. Shared components are copied automatically when write access is requested.

The components usually do not store data directly, but keep a reference to a data structure defined elsewhere. There is at most one component of each type:

#MeshComponent
#CurveComponent
#PointCloudComponent
#InstancesComponent
#VolumeComponent
#GreasePencilComponent

Copying a geometry set is a relatively cheap operation, because it does not copy the referenced geometry components, so GeometrySet can often be passed or moved by value.

Definition at line 146 of file BKE_geometry_set.hh.

Member Typedef Documentation

◆ AttributeForeachCallback

using blender::bke::GeometrySet::AttributeForeachCallback

Initial value:

 FunctionRef<void(StringRef attribute_id,
                                                    const AttributeMetaData &meta_data,
                                                    const GeometryComponent &component)>

Definition at line 250 of file BKE_geometry_set.hh.

◆ ForeachSubGeometryCallback

using blender::bke::GeometrySet::ForeachSubGeometryCallback = FunctionRef<void(GeometrySet &geometry_set)>

Definition at line 272 of file BKE_geometry_set.hh.

Constructor & Destructor Documentation

◆ GeometrySet() [1/3]

blender::bke::GeometrySet::GeometrySet ( )

default

The methods are defaulted here so that they are not instantiated in every translation unit.

◆ GeometrySet() [2/3]

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

default

◆ GeometrySet() [3/3]

blender::bke::GeometrySet::GeometrySet ( GeometrySet && other )

default

◆ ~GeometrySet()

blender::bke::GeometrySet::~GeometrySet ( )

default

Member Function Documentation

◆ add()

void blender::bke::GeometrySet::add ( const GeometryComponent & component )

Definition at line 187 of file geometry_set.cc.

References blender::ImplicitSharingInfo::add_user(), BLI_assert, and blender::bke::GeometryComponent::type().

Referenced by blender::geometry::join_component_type(), blender::nodes::node_geo_interpolate_curves_cc::node_geo_exec(), blender::nodes::node_geo_separate_components_cc::node_geo_exec(), blender::nodes::node_geo_sort_elements_cc::node_geo_exec(), and blender::geometry::realize_instances().

◆ attribute_foreach()

void blender::bke::GeometrySet::attribute_foreach	(	Span< GeometryComponent::Type >	component_types,
		bool	include_instances,
		AttributeForeachCallback	callback ) const

Definition at line 606 of file geometry_set.cc.

References attribute_foreach(), blender::bke::GeometryComponent::attributes(), callback, blender::bke::Instances::foreach_referenced_geometry(), get_component(), get_instances(), has(), has_instances(), and blender::bke::AttributeIter::name.

Referenced by attribute_foreach(), gather_attributes_for_propagation(), and blender::nodes::geo_eval_log::GeometryInfoLog::GeometryInfoLog().

◆ clear()

void blender::bke::GeometrySet::clear ( )

Remove all geometry components from the geometry set.

Definition at line 267 of file geometry_set.cc.

Referenced by blender::nodes::node_geo_duplicate_elements_cc::duplicate_instances(), blender::nodes::node_geo_duplicate_elements_cc::duplicate_layers(), blender::modifyGeometry(), blender::bke::bake::move_bake_items_to_socket_values(), and blender::bke::InstanceReference::to_geometry_set().

◆ compute_boundbox_without_instances()

std::optional< Bounds< float3 > > blender::bke::GeometrySet::compute_boundbox_without_instances ( ) const

Definition at line 206 of file geometry_set.cc.

References BKE_volume_min_max(), get_curves(), get_grease_pencil(), get_mesh(), get_pointcloud(), get_volume(), and blender::bounds::merge().

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

◆ count_memory()

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

Definition at line 595 of file geometry_set.cc.

References blender::memory_counter::MemoryCounter::add_shared().

◆ ensure_owns_all_data()

void blender::bke::GeometrySet::ensure_owns_all_data ( )

Same as ensure_owns_direct_data but also turns object/collection instances into geometry instances so that they can be owned.

Definition at line 288 of file geometry_set.cc.

References ensure_owns_direct_data(), and get_instances_for_write().

Referenced by blender::bke::bake::GeometryBakeItem::prepare_geometry_for_bake().

◆ ensure_owns_direct_data()

void blender::bke::GeometrySet::ensure_owns_direct_data ( )

Make sure that the geometry can be cached. This does not ensure ownership of object/collection instances. This is necessary because sometimes components only have read-only or editing access to their data, which might be freed later if this geometry set outlasts the data.

Definition at line 274 of file geometry_set.cc.

References blender::bke::GeometryComponent::ensure_owns_direct_data(), and get_component_for_write().

Referenced by blender::bke::mesh_surface_sample::BaryWeightFromPositionFn::BaryWeightFromPositionFn(), blender::bke::mesh_surface_sample::BaryWeightSampleFn::BaryWeightSampleFn(), blender::bke::mesh_surface_sample::CornerBaryWeightFromPositionFn::CornerBaryWeightFromPositionFn(), ensure_owns_all_data(), blender::bke::modifier_modify_mesh_and_geometry_set(), blender::nodes::node_geo_instance_on_points_cc::node_geo_exec(), blender::nodes::node_geo_proximity_cc::node_geo_exec(), blender::nodes::node_geo_raycast_cc::RaycastFunction::RaycastFunction(), blender::nodes::node_geo_sample_uv_surface_cc::ReverseUVSampleFunction::ReverseUVSampleFunction(), blender::nodes::node_geo_sample_index_cc::SampleIndexFunction::SampleIndexFunction(), blender::nodes::node_geo_sample_nearest_cc::SampleNearestFunction::SampleNearestFunction(), and blender::nodes::node_geo_sample_nearest_surface_cc::SampleNearestSurfaceFunction::SampleNearestSurfaceFunction().

◆ from_curves()

GeometrySet blender::bke::GeometrySet::from_curves	(	Curves *	curves,
		GeometryOwnershipType	ownership = GeometryOwnershipType::Owned )

static

Create a new geometry set that only contains the given curves.

Definition at line 432 of file geometry_set.cc.

References replace_curves().

◆ from_grease_pencil()

GeometrySet blender::bke::GeometrySet::from_grease_pencil	(	GreasePencil *	grease_pencil,
		GeometryOwnershipType	ownership = GeometryOwnershipType::Owned )

static

Create a new geometry set that only contains the given Grease Pencil data.

Definition at line 446 of file geometry_set.cc.

References replace_grease_pencil().

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

◆ from_instances()

GeometrySet blender::bke::GeometrySet::from_instances	(	Instances *	instances,
		GeometryOwnershipType	ownership = GeometryOwnershipType::Owned )

static

Create a new geometry set that only contains the given instances.

Definition at line 439 of file geometry_set.cc.

References replace_instances().

Referenced by blender::create_array_copies(), blender::create_mirror_copies(), blender::duplicate_strokes(), blender::bke::Instances::ensure_geometry_instances(), blender::nodes::node_geo_curve_to_mesh_cc::grease_pencil_to_mesh(), blender::nodes::node_geo_collection_info_cc::node_geo_exec(), blender::nodes::node_geo_geometry_to_instance_cc::node_geo_exec(), blender::nodes::node_geo_grease_pencil_to_curves_cc::node_geo_exec(), blender::nodes::node_geo_import_obj::node_geo_exec(), blender::nodes::node_geo_instance_on_points_cc::node_geo_exec(), blender::nodes::node_geo_object_info_cc::node_geo_exec(), and blender::bke::object_get_evaluated_geometry_set().

◆ from_mesh()

GeometrySet blender::bke::GeometrySet::from_mesh	(	Mesh *	mesh,
		GeometryOwnershipType	ownership = GeometryOwnershipType::Owned )

static

Create a new geometry set that only contains the given mesh.

Definition at line 411 of file geometry_set.cc.

References replace_mesh().

◆ from_pointcloud()

GeometrySet blender::bke::GeometrySet::from_pointcloud	(	PointCloud *	pointcloud,
		GeometryOwnershipType	ownership = GeometryOwnershipType::Owned )

static

Create a new geometry set that only contains the given point cloud.

Definition at line 425 of file geometry_set.cc.

References replace_pointcloud().

Referenced by BKE_pointcloud_data_update(), blender::ed::geometry::get_original_geometry_eval_copy(), blender::nodes::node_geo_distribute_points_in_grid_cc::node_geo_exec(), blender::nodes::node_geo_points_cc::node_geo_exec(), blender::io::usd::USDPointsReader::read_object_data(), and blender::io::alembic::AbcPointsReader::readObjectData().

◆ from_volume()

GeometrySet blender::bke::GeometrySet::from_volume	(	Volume *	volume,
		GeometryOwnershipType	ownership = GeometryOwnershipType::Owned )

static

Create a new geometry set that only contains the given volume.

Definition at line 418 of file geometry_set.cc.

References replace_volume().

◆ gather_attributes_for_propagation()

void blender::bke::GeometrySet::gather_attributes_for_propagation	(	Span< GeometryComponent::Type >	component_types,
		GeometryComponent::Type	dst_component_type,
		bool	include_instances,
		const AttributeFilter &	attribute_filter,
		Map< StringRef, AttributeKind > &	r_attributes ) const

Definition at line 692 of file geometry_set.cc.

References blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add_or_modify(), blender::bke::AttributeFilter::allow_skip(), blender::bke::attribute_data_type_highest_complexity(), blender::bke::attribute_domain_highest_priority(), attribute_foreach(), blender::bke::GeometryComponent::attributes(), CD_PROP_STRING, blender::bke::AttributeMetaData::data_type, blender::bke::AttributeMetaData::domain, blender::bke::Instance, blender::bke::GeometryComponent::Instance, and blender::bke::Point.

Referenced by blender::nodes::node_geo_instances_to_points_cc::convert_instances_to_points(), blender::nodes::node_geo_mesh_to_points_cc::geometry_set_mesh_to_points(), blender::nodes::node_geo_points_to_vertices_cc::geometry_set_points_to_vertices(), blender::nodes::node_geo_instance_on_points_cc::node_geo_exec(), and blender::nodes::node_geo_distribute_points_on_faces_cc::point_distribution_calculate().

◆ gather_component_types()

Vector< GeometryComponent::Type > blender::bke::GeometrySet::gather_component_types	(	bool	include_instances,
		bool	ignore_empty ) const

Definition at line 766 of file geometry_set.cc.

References blender::bke::gather_component_types_recursive(), and types.

Referenced by blender::nodes::GeoNodeExecParams::check_input_geometry_set(), and blender::nodes::node_geo_duplicate_elements_cc::duplicate_points().

◆ get_component() [1/2]

template<typename Component >

const Component * blender::bke::GeometrySet::get_component ( ) const

inline

Definition at line 184 of file BKE_geometry_set.hh.

References BLI_STATIC_ASSERT, get_component(), and blender::bke::is_geometry_component_v.

Referenced by attribute_foreach(), get_component(), get_curve_edit_hints(), get_curves(), get_gizmo_edit_hints(), get_grease_pencil(), get_instances(), get_mesh(), get_pointcloud(), get_volume(), has_curves(), has_grease_pencil(), has_instances(), has_mesh(), has_pointcloud(), and has_volume().

◆ get_component() [2/2]

const GeometryComponent * blender::bke::GeometrySet::get_component ( GeometryComponent::Type component_type ) const

Get the component of the given type. Might return null if the component does not exist yet.

Definition at line 147 of file geometry_set.cc.

◆ get_component_for_write() [1/2]

template<typename Component >

Component & blender::bke::GeometrySet::get_component_for_write ( )

inline

Definition at line 174 of file BKE_geometry_set.hh.

References BLI_STATIC_ASSERT, get_component_for_write(), and blender::bke::is_geometry_component_v.

Referenced by ensure_owns_direct_data(), get_component_for_write(), get_curve_edit_hints_for_write(), get_gizmo_edit_hints_for_write(), replace_curves(), replace_grease_pencil(), replace_instances(), replace_mesh(), replace_pointcloud(), and replace_volume().

◆ get_component_for_write() [2/2]

GeometryComponent & blender::bke::GeometrySet::get_component_for_write ( GeometryComponent::Type component_type )

This method can only be used when the geometry set is mutable. It returns a mutable geometry component of the given type.

Definition at line 120 of file geometry_set.cc.

References blender::bke::GeometryComponent::create().

◆ get_components()

Vector< const GeometryComponent * > blender::bke::GeometrySet::get_components ( ) const

Get all geometry components in this geometry set for read-only access.

Definition at line 195 of file geometry_set.cc.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append().

Referenced by blender::bke::gather_component_types_recursive(), blender::geometry::gather_realize_tasks_recursive(), blender::nodes::node_geo_attribute_statistic_cc::node_geo_exec(), and blender::nodes::LazyFunctionForForeachGeometryElementZone::prepare_components().

◆ get_curve_edit_hints()

const CurvesEditHints * blender::bke::GeometrySet::get_curve_edit_hints ( ) const

Returns read-only curve edit hints or null.

Definition at line 344 of file geometry_set.cc.

References blender::bke::GeometryComponentEditData::curves_edit_hints_, and get_component().

Referenced by blender::nodes::GeoNodeExecParams::check_output_geometry_set().

◆ get_curve_edit_hints_for_write()

CurvesEditHints * blender::bke::GeometrySet::get_curve_edit_hints_for_write ( )

Returns mutable curve edit hints or null.

Definition at line 569 of file geometry_set.cc.

References blender::bke::GeometryComponentEditData::curves_edit_hints_, get_component_for_write(), and has().

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

◆ get_curves()

const Curves * blender::bke::GeometrySet::get_curves ( ) const

Returns a read-only curves data-block or null.

Definition at line 332 of file geometry_set.cc.

References blender::bke::CurveComponent::get(), and get_component().

◆ get_curves_for_write()

Curves * blender::bke::GeometrySet::get_curves_for_write ( )

Returns a mutable curves data-block or null. No ownership is transferred.

Definition at line 557 of file geometry_set.cc.

References blender::bke::CurveComponent::get_for_write().

◆ get_gizmo_edit_hints()

const GizmoEditHints * blender::bke::GeometrySet::get_gizmo_edit_hints ( ) const

Returns read-only gizmo edit hints or null.

Definition at line 350 of file geometry_set.cc.

References get_component(), and blender::bke::GeometryComponentEditData::gizmo_edit_hints_.

◆ get_gizmo_edit_hints_for_write()

GizmoEditHints * blender::bke::GeometrySet::get_gizmo_edit_hints_for_write ( )

Returns mutable gizmo edit hints or null.

Definition at line 579 of file geometry_set.cc.

References get_component_for_write(), blender::bke::GeometryComponentEditData::gizmo_edit_hints_, and has().

◆ get_grease_pencil()

const GreasePencil * blender::bke::GeometrySet::get_grease_pencil ( ) const

Returns a read-only Grease Pencil data-block or null.

Definition at line 356 of file geometry_set.cc.

References blender::bke::GreasePencilComponent::get(), and get_component().

Referenced by BKE_grease_pencil_data_update(), blender::nodes::GeoNodeExecParams::check_input_geometry_set(), compute_boundbox_without_instances(), blender::nodes::node_geo_curve_fill_cc::curve_fill_calculate(), blender::nodes::node_geo_duplicate_elements_cc::duplicate_layers(), blender::geometry::gather_grease_pencils_to_realize(), blender::nodes::node_geo_curve_to_mesh_cc::grease_pencil_to_mesh(), make_duplis_geometry_set_impl(), blender::nodes::node_geo_curve_length_cc::node_geo_exec(), blender::nodes::node_geo_grease_pencil_to_curves_cc::node_geo_exec(), blender::nodes::node_geo_instance_on_points_cc::node_geo_exec(), blender::nodes::LazyFunctionForForeachGeometryElementZone::prepare_components(), replace_grease_pencil(), blender::geometry::separate_geometry(), and blender::nodes::LazyFunctionForForeachGeometryElementZone::try_extract_element_geometries().

◆ get_grease_pencil_for_write()

GreasePencil * blender::bke::GeometrySet::get_grease_pencil_for_write ( )

Returns a mutable Grease Pencil data-block or null. No ownership is transferred.

Definition at line 589 of file geometry_set.cc.

References blender::bke::GreasePencilComponent::get_for_write().

◆ get_instances()

const Instances * blender::bke::GeometrySet::get_instances ( ) const

Returns read-only instances or null.

Definition at line 338 of file geometry_set.cc.

References blender::bke::InstancesComponent::get(), and get_component().

Referenced by attribute_foreach(), blender::ed::spreadsheet::GeometryInstancesTreeView::build_tree(), blender::ed::spreadsheet::GeometryInstancesTreeView::build_tree_for_instances(), blender::nodes::node_geo_instances_to_points_cc::convert_instances_to_points(), blender::nodes::node_geo_duplicate_elements_cc::duplicate_instances(), blender::bke::gather_component_types_recursive(), blender::geometry::gather_curves_to_realize(), blender::geometry::gather_grease_pencils_to_realize(), blender::geometry::gather_meshes_to_realize(), blender::geometry::gather_pointclouds_to_realize(), make_duplis_geometry_set_impl(), blender::nodes::node_geo_curves_to_grease_pencil_cc::node_geo_exec(), blender::nodes::node_geo_realize_instances_cc::node_geo_exec(), blender::nodes::node_geo_sort_elements_cc::node_geo_exec(), OVERLAY_viewer_attribute_text(), blender::geometry::propagate_instances_to_keep(), blender::geometry::realize_instances(), replace_instances(), and blender::nodes::LazyFunctionForForeachGeometryElementZone::try_extract_element_geometries().

◆ get_instances_for_write()

Instances * blender::bke::GeometrySet::get_instances_for_write ( )

Returns mutable instances or null. No ownership is transferred.

Definition at line 563 of file geometry_set.cc.

References blender::bke::InstancesComponent::get_for_write().

Referenced by blender::geometry::delete_selected_instances(), blender::bke::Instances::ensure_geometry_instances(), ensure_owns_all_data(), blender::bke::gather_mutable_geometry_sets(), blender::nodes::node_geo_instance_on_points_cc::node_geo_exec(), blender::nodes::node_geo_rotate_instances_cc::node_geo_exec(), blender::nodes::node_geo_scale_instances_cc::node_geo_exec(), blender::nodes::node_geo_store_named_attribute_cc::node_geo_exec(), blender::nodes::node_geo_translate_instances_cc::node_geo_exec(), and blender::geometry::remove_id_attribute_from_instances().

◆ get_mesh()

const Mesh * blender::bke::GeometrySet::get_mesh ( ) const

Returns a read-only mesh or null.

Definition at line 308 of file geometry_set.cc.

References blender::bke::MeshComponent::get(), and get_component().

◆ get_mesh_for_write()

Mesh * blender::bke::GeometrySet::get_mesh_for_write ( )

Returns a mutable mesh or null. No ownership is transferred.

Definition at line 539 of file geometry_set.cc.

References blender::bke::MeshComponent::get_for_write().

Referenced by curve_calc_modifiers_post(), blender::modifyGeometry(), blender::nodes::node_geo_edge_split_cc::node_geo_exec(), blender::nodes::node_geo_extrude_mesh_cc::node_geo_exec(), blender::nodes::node_geo_flip_faces_cc::node_geo_exec(), blender::nodes::node_geo_set_material_index_cc::node_geo_exec(), blender::nodes::node_geo_set_shade_smooth_cc::node_geo_exec(), blender::nodes::node_geo_store_named_attribute_cc::node_geo_exec(), blender::io::alembic::AbcMeshReader::read_geometry(), blender::io::alembic::AbcSubDReader::read_geometry(), blender::io::usd::USDMeshReader::read_geometry(), and blender::io::usd::USDShapeReader::read_geometry().

◆ get_pointcloud()

const PointCloud * blender::bke::GeometrySet::get_pointcloud ( ) const

Returns a read-only point cloud of null.

Definition at line 320 of file geometry_set.cc.

References blender::bke::PointCloudComponent::get(), and get_component().

Referenced by blender::nodes::GeoNodeExecParams::check_input_geometry_set(), compute_boundbox_without_instances(), blender::nodes::node_geo_duplicate_elements_cc::duplicate_points_pointcloud(), blender::geometry::gather_pointclouds_to_realize(), blender::nodes::node_geo_points_to_vertices_cc::geometry_set_points_to_vertices(), make_duplis_geometry_set_impl(), modify_geometry_set(), blender::nodes::node_geo_merge_by_distance_cc::node_geo_exec(), blender::nodes::node_geo_points_to_curves_cc::node_geo_exec(), blender::nodes::node_geo_proximity_cc::ProximityFunction::ProximityFunction(), replace_pointcloud(), blender::geometry::separate_geometry(), and blender::nodes::LazyFunctionForForeachGeometryElementZone::try_extract_element_geometries().

◆ get_pointcloud_for_write()

PointCloud * blender::bke::GeometrySet::get_pointcloud_for_write ( )

Returns a mutable point cloud or null. No ownership is transferred.

Definition at line 545 of file geometry_set.cc.

References blender::bke::PointCloudComponent::get_for_write().

Referenced by blender::nodes::node_geo_set_point_radius_cc::node_geo_exec(), blender::io::alembic::AbcPointsReader::read_geometry(), and blender::io::usd::USDPointsReader::read_geometry().

◆ get_volume()

const Volume * blender::bke::GeometrySet::get_volume ( ) const

Returns a read-only volume or null.

Definition at line 326 of file geometry_set.cc.

References blender::bke::VolumeComponent::get(), and get_component().

Referenced by compute_boundbox_without_instances(), make_duplis_geometry_set_impl(), and replace_volume().

◆ get_volume_for_write()

Volume * blender::bke::GeometrySet::get_volume_for_write ( )

Returns a mutable volume or null. No ownership is transferred.

Definition at line 551 of file geometry_set.cc.

References blender::bke::VolumeComponent::get_for_write().

Referenced by modify_geometry_set(), modify_geometry_set(), and blender::nodes::node_geo_get_named_grid_cc::node_geo_exec().

◆ has() [1/2]

template<typename Component >

bool blender::bke::GeometrySet::has ( ) const

inline

Definition at line 191 of file BKE_geometry_set.hh.

References BLI_STATIC_ASSERT, has(), and blender::bke::is_geometry_component_v.

Referenced by attribute_foreach(), get_curve_edit_hints_for_write(), get_gizmo_edit_hints_for_write(), and has().

◆ has() [2/2]

bool blender::bke::GeometrySet::has ( const GeometryComponent::Type component_type ) const

Definition at line 152 of file geometry_set.cc.

References blender::ImplicitSharingPtr< T, IsStrong >::has_value().

Referenced by blender::ed::spreadsheet::data_source_from_geometry(), blender::bke::crazyspace::get_evaluated_grease_pencil_drawing_deformation(), blender::nodes::LazyFunctionForReduceForeachGeometryElement::handle_generation_items_group(), blender::bke::modifier_modify_mesh_and_geometry_set(), blender::nodes::node_geo_attribute_capture_cc::node_geo_exec(), blender::nodes::node_geo_instance_on_points_cc::node_geo_exec(), blender::nodes::node_geo_remove_attribute_cc::node_geo_exec(), blender::nodes::node_geo_separate_components_cc::node_geo_exec(), blender::nodes::node_geo_set_id_cc::node_geo_exec(), blender::nodes::node_geo_store_named_attribute_cc::node_geo_exec(), take_pointcloud_ownership_from_geometry_set(), and take_volume_ownership_from_geometry_set().

◆ has_component()

template<typename Component >

bool blender::bke::GeometrySet::has_component ( ) const

inline

Definition at line 197 of file BKE_geometry_set.hh.

References BLI_STATIC_ASSERT, int, and blender::bke::is_geometry_component_v.

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

◆ has_curves()

bool blender::bke::GeometrySet::has_curves ( ) const

Returns true when the geometry set has a curves component that has a curves data-block.

Definition at line 381 of file geometry_set.cc.

References get_component(), and blender::bke::CurveComponent::has_curves().

◆ has_grease_pencil()

bool blender::bke::GeometrySet::has_grease_pencil ( ) const

Returns true when the geometry set has a Grease Pencil component that has grease pencil data.

Definition at line 399 of file geometry_set.cc.

References get_component(), and blender::bke::GreasePencilComponent::has_grease_pencil().

◆ has_instances()

bool blender::bke::GeometrySet::has_instances ( ) const

Returns true when the geometry set has an instances component that has at least one instance.

Definition at line 368 of file geometry_set.cc.

References blender::bke::InstancesComponent::get(), get_component(), and blender::bke::Instances::instances_num().

◆ has_mesh()

bool blender::bke::GeometrySet::has_mesh ( ) const

Returns true when the geometry set has a mesh component that has a mesh.

Definition at line 314 of file geometry_set.cc.

References get_component(), and blender::bke::MeshComponent::has_mesh().

◆ has_pointcloud()

bool blender::bke::GeometrySet::has_pointcloud ( ) const

Returns true when the geometry set has a point cloud component that has a point cloud.

Definition at line 362 of file geometry_set.cc.

References get_component(), and blender::bke::PointCloudComponent::has_pointcloud().

Referenced by blender::nodes::node_geo_duplicate_elements_cc::duplicate_points(), is_empty(), blender::ed::object::modifier_apply_obdata(), modify_geometry_set(), blender::nodes::node_geo_split_to_instances_cc::node_geo_exec(), blender::nodes::node_geo_proximity_cc::ProximityFunction::ProximityFunction(), and blender::io::alembic::AbcPointsReader::read_geometry().

◆ has_realized_data()

bool blender::bke::GeometrySet::has_realized_data ( ) const

Returns true when the geometry set has any data that is not an instance.

Definition at line 387 of file geometry_set.cc.

References blender::bke::GeometryComponent::Instance.

Referenced by blender::nodes::GeoNodeExecParams::check_input_geometry_set(), and blender::geometry::separate_geometry().

◆ has_volume()

bool blender::bke::GeometrySet::has_volume ( ) const

Returns true when the geometry set has a volume component that has a volume.

Definition at line 375 of file geometry_set.cc.

References get_component(), and blender::bke::VolumeComponent::has_volume().

Referenced by is_empty(), and blender::nodes::node_geo_distribute_points_in_volume_cc::node_geo_exec().

◆ hash()

uint64_t blender::bke::GeometrySet::hash ( ) const

inline

Definition at line 449 of file BKE_geometry_set.hh.

References blender::get_default_hash().

◆ is_empty()

bool blender::bke::GeometrySet::is_empty ( ) const

Return true if the geometry set has any component that isn't empty.

Definition at line 405 of file geometry_set.cc.

References has_curves(), has_grease_pencil(), has_instances(), has_mesh(), has_pointcloud(), and has_volume().

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

◆ keep_only()

void blender::bke::GeometrySet::keep_only ( Span< GeometryComponent::Type > component_types )

Remove all geometry components with types that are not in the provided list.

Definition at line 163 of file geometry_set.cc.

References blender::Span< T >::contains().

Referenced by blender::nodes::LazyFunctionForReduceForeachGeometryElement::handle_generation_items_group(), keep_only_during_modify(), blender::nodes::node_geo_edge_paths_to_curves_cc::node_geo_exec(), and blender::nodes::node_geo_instances_to_points_cc::node_geo_exec().

◆ keep_only_during_modify()

void blender::bke::GeometrySet::keep_only_during_modify ( Span< GeometryComponent::Type > component_types )

Keeps the provided geometry types, but also instances and edit data. Instances must not be removed while using modify_geometry_sets.

Definition at line 174 of file geometry_set.cc.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append_non_duplicates(), blender::bke::GeometryComponent::Edit, blender::bke::GeometryComponent::Instance, and keep_only().

◆ modify_geometry_sets()

void blender::bke::GeometrySet::modify_geometry_sets ( ForeachSubGeometryCallback callback )

Modify every (recursive) instance separately. This is often more efficient than realizing all instances just to change the same thing on all of them.

Definition at line 793 of file geometry_set.cc.

References callback, blender::Vector< T, InlineBufferCapacity, Allocator >::first(), blender::bke::gather_mutable_geometry_sets(), blender::threading::parallel_for_each(), and blender::Vector< T, InlineBufferCapacity, Allocator >::size().

◆ operator=() [1/2]

GeometrySet & blender::bke::GeometrySet::operator= ( const GeometrySet & other )

default

◆ operator=() [2/2]

GeometrySet & blender::bke::GeometrySet::operator= ( GeometrySet && other )

default

◆ owns_direct_data()

bool blender::bke::GeometrySet::owns_direct_data ( ) const

Definition at line 296 of file geometry_set.cc.

◆ propagate_attributes_from_layer_to_instances()

void blender::bke::GeometrySet::propagate_attributes_from_layer_to_instances	(	const AttributeAccessor	src_attributes,
		MutableAttributeAccessor	dst_attributes,
		const AttributeFilter &	attribute_filter )

static

Definition at line 630 of file geometry_set.cc.

References blender::bke::MutableAttributeAccessor::add(), blender::bke::AttributeFilter::allow_skip(), blender::array_utils::copy(), blender::bke::AttributeIter::data_type, blender::bke::GSpanAttributeWriter::finish(), blender::bke::AttributeAccessor::foreach_attribute(), blender::bke::AttributeIter::get(), init(), blender::bke::Instance, blender::bke::Layer, blender::bke::MutableAttributeAccessor::lookup_or_add_for_write_only_span(), blender::bke::AttributeIter::name, and blender::bke::GSpanAttributeWriter::span.

Referenced by blender::nodes::node_geo_curve_to_mesh_cc::grease_pencil_to_mesh(), and blender::nodes::node_geo_instance_on_points_cc::node_geo_exec().

◆ remove() [1/2]

template<typename Component >

void blender::bke::GeometrySet::remove ( )

inline

Definition at line 204 of file BKE_geometry_set.hh.

References BLI_STATIC_ASSERT, blender::bke::is_geometry_component_v, and remove().

Referenced by remove(), replace_curves(), replace_grease_pencil(), replace_instances(), replace_mesh(), replace_pointcloud(), and replace_volume().

◆ remove() [2/2]

void blender::bke::GeometrySet::remove ( const GeometryComponent::Type component_type )

Definition at line 158 of file geometry_set.cc.

Referenced by blender::geometry::delete_selected_instances(), blender::nodes::node_geo_sort_elements_cc::node_geo_exec(), blender::geometry::separate_geometry(), take_pointcloud_ownership_from_geometry_set(), and take_volume_ownership_from_geometry_set().

◆ remove_geometry_during_modify()

void blender::bke::GeometrySet::remove_geometry_during_modify ( )

Definition at line 182 of file geometry_set.cc.

References keep_only_during_modify().

Referenced by blender::nodes::node_geo_duplicate_elements_cc::duplicate_edges(), blender::nodes::node_geo_duplicate_elements_cc::duplicate_faces(), blender::nodes::node_geo_mesh_to_points_cc::geometry_set_mesh_to_points(), blender::nodes::node_geo_points_to_vertices_cc::geometry_set_points_to_vertices(), blender::nodes::node_geo_bounding_box_cc::node_geo_exec(), blender::nodes::node_geo_instance_on_points_cc::node_geo_exec(), and blender::nodes::node_geo_mesh_to_curve_cc::node_geo_exec().

◆ replace_curves()

void blender::bke::GeometrySet::replace_curves	(	Curves *	curves,
		GeometryOwnershipType	ownership = GeometryOwnershipType::Owned )

Clear the existing curves data-block and replace it with the given one.

Definition at line 468 of file geometry_set.cc.

References get_component_for_write(), get_curves(), remove(), and blender::bke::CurveComponent::replace().

◆ replace_grease_pencil()

void blender::bke::GeometrySet::replace_grease_pencil	(	GreasePencil *	grease_pencil,
		GeometryOwnershipType	ownership = GeometryOwnershipType::Owned )

Clear the existing Grease Pencil data-block and replace it with the given one.

Definition at line 524 of file geometry_set.cc.

References get_component_for_write(), get_grease_pencil(), remove(), and blender::bke::GreasePencilComponent::replace().

Referenced by BKE_grease_pencil_data_update(), blender::nodes::node_geo_curve_fill_cc::curve_fill_calculate(), blender::nodes::node_geo_duplicate_elements_cc::duplicate_layers(), blender::geometry::execute_realize_grease_pencil_tasks(), from_grease_pencil(), blender::nodes::node_geo_curve_to_mesh_cc::grease_pencil_to_mesh(), blender::nodes::node_geo_curve_to_points_cc::grease_pencil_to_points(), blender::nodes::node_geo_instance_on_points_cc::node_geo_exec(), blender::geometry::separate_geometry(), and blender::ed::spreadsheet::spreadsheet_get_display_geometry_set().

◆ replace_instances()

void blender::bke::GeometrySet::replace_instances	(	Instances *	instances,
		GeometryOwnershipType	ownership = GeometryOwnershipType::Owned )

Clear the existing instances and replace them with the given one.

Definition at line 482 of file geometry_set.cc.

References get_component_for_write(), get_instances(), remove(), and blender::bke::InstancesComponent::replace().

Referenced by blender::geometry::execute_instances_tasks(), from_instances(), blender::nodes::node_geo_sort_elements_cc::node_geo_exec(), and blender::bke::InstanceReference::to_geometry_set().

◆ replace_mesh()

void blender::bke::GeometrySet::replace_mesh	(	Mesh *	mesh,
		GeometryOwnershipType	ownership = GeometryOwnershipType::Owned )

Clear the existing mesh and replace it with the given one.

Definition at line 454 of file geometry_set.cc.

References get_component_for_write(), get_mesh(), remove(), and blender::bke::MeshComponent::replace().

◆ replace_pointcloud()

void blender::bke::GeometrySet::replace_pointcloud	(	PointCloud *	pointcloud,
		GeometryOwnershipType	ownership = GeometryOwnershipType::Owned )

Clear the existing point cloud and replace with the given one.

Definition at line 496 of file geometry_set.cc.

References get_component_for_write(), get_pointcloud(), remove(), and blender::bke::PointCloudComponent::replace().

Referenced by blender::nodes::node_geo_instances_to_points_cc::convert_instances_to_points(), blender::nodes::node_geo_duplicate_elements_cc::duplicate_points_pointcloud(), blender::geometry::execute_realize_pointcloud_tasks(), from_pointcloud(), blender::nodes::node_geo_mesh_to_points_cc::geometry_set_mesh_to_points(), blender::nodes::node_geo_distribute_points_in_volume_cc::node_geo_exec(), blender::nodes::node_geo_merge_by_distance_cc::node_geo_exec(), blender::nodes::node_geo_distribute_points_on_faces_cc::point_distribution_calculate(), blender::io::alembic::AbcPointsReader::read_geometry(), blender::io::usd::USDPointsReader::read_geometry(), blender::geometry::separate_geometry(), and blender::ed::spreadsheet::spreadsheet_get_display_geometry_set().

◆ replace_volume()

void blender::bke::GeometrySet::replace_volume	(	Volume *	volume,
		GeometryOwnershipType	ownership = GeometryOwnershipType::Owned )

Clear the existing volume and replace with the given one.

Definition at line 510 of file geometry_set.cc.

References get_component_for_write(), get_volume(), remove(), and blender::bke::VolumeComponent::replace().

Referenced by BKE_volume_data_update(), from_volume(), modify_geometry_set(), and blender::nodes::node_geo_volume_cube_cc::node_geo_exec().

Friends And Related Symbol Documentation

◆ operator<<

std::ostream & operator<<	(	std::ostream &	stream,
		const GeometrySet &	geometry_set )

friend

Definition at line 227 of file geometry_set.cc.

◆ operator==

bool operator==	(	const GeometrySet &	a,
		const GeometrySet &	b )

friend

Definition at line 443 of file BKE_geometry_set.hh.

Member Data Documentation

◆ name

std::string blender::bke::GeometrySet::name

A user defined name for this geometry. It is not expected to be unique. Its main purpose is help debugging instance trees. It may eventually also be used when exporting instance trees or when creating separate objects from them.

Definition at line 157 of file BKE_geometry_set.hh.

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

Public Types

Public Member Functions

Public Attributes

Friends

Geometry Set

Detailed Description

Member Typedef Documentation

◆ AttributeForeachCallback

◆ ForeachSubGeometryCallback

Constructor & Destructor Documentation

◆ GeometrySet() [1/3]

◆ GeometrySet() [2/3]

◆ GeometrySet() [3/3]

◆ ~GeometrySet()

Member Function Documentation

◆ add()

◆ attribute_foreach()

◆ clear()

◆ compute_boundbox_without_instances()

◆ count_memory()

◆ ensure_owns_all_data()

◆ ensure_owns_direct_data()

◆ from_curves()

◆ from_grease_pencil()

◆ from_instances()

◆ from_mesh()

◆ from_pointcloud()

◆ from_volume()

◆ gather_attributes_for_propagation()

◆ gather_component_types()

◆ get_component() [1/2]

◆ get_component() [2/2]

◆ get_component_for_write() [1/2]

◆ get_component_for_write() [2/2]

◆ get_components()

◆ get_curve_edit_hints()

◆ get_curve_edit_hints_for_write()

◆ get_curves()

◆ get_curves_for_write()

◆ get_gizmo_edit_hints()

◆ get_gizmo_edit_hints_for_write()

◆ get_grease_pencil()

◆ get_grease_pencil_for_write()

◆ get_instances()

◆ get_instances_for_write()

◆ get_mesh()

◆ get_mesh_for_write()

◆ get_pointcloud()

◆ get_pointcloud_for_write()

◆ get_volume()

◆ get_volume_for_write()

◆ has() [1/2]

◆ has() [2/2]

◆ has_component()

◆ has_curves()

◆ has_grease_pencil()

◆ has_instances()

◆ has_mesh()

◆ has_pointcloud()

◆ has_realized_data()

◆ has_volume()

◆ hash()

◆ is_empty()

◆ keep_only()

◆ keep_only_during_modify()

◆ modify_geometry_sets()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ owns_direct_data()

◆ propagate_attributes_from_layer_to_instances()

◆ remove() [1/2]

◆ remove() [2/2]

◆ remove_geometry_during_modify()

◆ replace_curves()

◆ replace_grease_pencil()

◆ replace_instances()

◆ replace_mesh()

◆ replace_pointcloud()

◆ replace_volume()

Friends And Related Symbol Documentation