Blender V5.0
Static Public Attributes | List of all members
blender::bke::InstancesComponent Class Reference

#include <BKE_geometry_set.hh>

Inherits blender::bke::GeometryComponent.

Public Member Functions

Geometry Component Implementation
 InstancesComponent ()
 InstancesComponent (Instances *instances, GeometryOwnershipType ownership=GeometryOwnershipType::Owned)
 ~InstancesComponent () override
GeometryComponentPtr copy () const override
void clear () override
const Instances * get () const
Instances * get_for_write ()
void replace (Instances *instances, GeometryOwnershipType ownership=GeometryOwnershipType::Owned)
bool is_empty () const final
Instances * release ()
bool owns_direct_data () const override
void ensure_owns_direct_data () override
void count_memory (MemoryCounter &memory) const override
std::optional< AttributeAccessor > attributes () const final
std::optional< MutableAttributeAccessor > attributes_for_write () final
Public Member Functions inherited from blender::bke::GeometryComponent
 ~GeometryComponent () override=default
 GeometryComponent (Type type)
int attribute_domain_size (AttrDomain domain) const
Type type () const
Public Member Functions inherited from blender::ImplicitSharingInfo
virtual ~ImplicitSharingInfo ()
bool is_mutable () const
bool is_expired () const
void add_user () const
void add_weak_user () const
void tag_ensured_mutable () const
int64_t version () const
int strong_users () const
void remove_user_and_delete_if_last () const
void remove_weak_user_and_delete_if_last () const

Static Public Attributes

static constexpr GeometryComponent::Type static_type = Type::Instance

Additional Inherited Members

Public Types inherited from blender::bke::GeometryComponent
enum class  Type {
  Mesh = 0 , PointCloud = 1 , Instance = 2 , Volume = 3 ,
  Curve = 4 , Edit = 5 , GreasePencil = 6
}
static GeometryComponentPtr create (Type component_type)

Detailed Description

A geometry component that stores Instances.

Definition at line 641 of file BKE_geometry_set.hh.

Constructor & Destructor Documentation

◆ InstancesComponent() [1/2]

blender::bke::InstancesComponent::InstancesComponent ( )

Definition at line 16 of file geometry_component_instances.cc.

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

Referenced by copy().

◆ InstancesComponent() [2/2]

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

Definition at line 18 of file geometry_component_instances.cc.

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

◆ ~InstancesComponent()

blender::bke::InstancesComponent::~InstancesComponent ( )
override

Definition at line 23 of file geometry_component_instances.cc.

References clear().

Member Function Documentation

◆ attributes()

std::optional< AttributeAccessor > blender::bke::InstancesComponent::attributes ( ) const
finalvirtual

Get access to the attributes in this geometry component. May return none if the geometry does not support the attribute system.

Reimplemented from blender::bke::GeometryComponent.

Definition at line 110 of file geometry_component_instances.cc.

References blender::bke::instance_attribute_accessor_functions().

Referenced by find_geonode_attribute_rgba().

◆ attributes_for_write()

std::optional< MutableAttributeAccessor > blender::bke::InstancesComponent::attributes_for_write ( )
finalvirtual

Reimplemented from blender::bke::GeometryComponent.

Definition at line 115 of file geometry_component_instances.cc.

References blender::bke::instance_attribute_accessor_functions().

◆ clear()

void blender::bke::InstancesComponent::clear ( )
overridevirtual

Remove referenced data from the geometry component.

Implements blender::bke::GeometryComponent.

Definition at line 38 of file geometry_component_instances.cc.

References BLI_assert, blender::ImplicitSharingInfo::is_expired(), blender::ImplicitSharingInfo::is_mutable(), and blender::bke::Owned.

Referenced by replace(), and ~InstancesComponent().

◆ copy()

GeometryComponentPtr blender::bke::InstancesComponent::copy ( ) const
overridevirtual

Copies the component. The returned component only has a single user and is therefor mutable.

Implements blender::bke::GeometryComponent.

Definition at line 28 of file geometry_component_instances.cc.

References InstancesComponent(), and blender::bke::Owned.

Referenced by blender::geometry::realize_instances().

◆ count_memory()

void blender::bke::InstancesComponent::count_memory ( MemoryCounter & memory) const
overridevirtual

Reimplemented from blender::bke::GeometryComponent.

Definition at line 103 of file geometry_component_instances.cc.

◆ ensure_owns_direct_data()

void blender::bke::InstancesComponent::ensure_owns_direct_data ( )
overridevirtual

Implements blender::bke::GeometryComponent.

Definition at line 65 of file geometry_component_instances.cc.

◆ get()

const Instances * blender::bke::InstancesComponent::get ( ) const

Definition at line 72 of file geometry_component_instances.cc.

Referenced by blender::io::usd::USDPointInstancerWriter::do_write(), blender::geometry::execute_instances_tasks(), blender::ed::spreadsheet::GeometryDataSource::get_column_values(), blender::bke::GeometrySet::get_instances(), blender::bke::GeometrySet::has_instances(), and blender::nodes::node_geo_split_to_instances_cc::split_instance_groups().

◆ get_for_write()

Instances * blender::bke::InstancesComponent::get_for_write ( )

Definition at line 77 of file geometry_component_instances.cc.

References BLI_assert, blender::ImplicitSharingInfo::is_mutable(), blender::bke::Owned, and blender::bke::ReadOnly.

Referenced by blender::nodes::node_geo_curve_fill_cc::curve_fill_calculate(), and blender::bke::GeometrySet::get_instances_for_write().

◆ is_empty()

bool blender::bke::InstancesComponent::is_empty ( ) const
finalvirtual

Reimplemented from blender::bke::GeometryComponent.

Definition at line 47 of file geometry_component_instances.cc.

◆ owns_direct_data()

bool blender::bke::InstancesComponent::owns_direct_data ( ) const
overridevirtual

Implements blender::bke::GeometryComponent.

Definition at line 57 of file geometry_component_instances.cc.

◆ release()

Instances * blender::bke::InstancesComponent::release ( )

Definition at line 95 of file geometry_component_instances.cc.

References BLI_assert, and blender::ImplicitSharingInfo::is_mutable().

Referenced by blender::nodes::node_geo_curve_to_mesh_cc::grease_pencil_to_mesh(), and blender::nodes::node_geo_curve_to_points_cc::layer_pointclouds_to_instances().

◆ replace()

void blender::bke::InstancesComponent::replace ( Instances * instances,
GeometryOwnershipType ownership = GeometryOwnershipType::Owned )

Definition at line 87 of file geometry_component_instances.cc.

References BLI_assert, clear(), and blender::ImplicitSharingInfo::is_mutable().

Referenced by blender::nodes::node_geo_curve_fill_cc::curve_fill_calculate(), blender::nodes::node_geo_curve_to_mesh_cc::grease_pencil_to_mesh(), blender::nodes::node_geo_curve_to_points_cc::layer_pointclouds_to_instances(), blender::geometry::propagate_instances_to_keep(), and blender::bke::GeometrySet::replace_instances().

Member Data Documentation

◆ static_type

GeometryComponent::Type blender::bke::InstancesComponent::static_type = Type::Instance
staticconstexpr

Definition at line 673 of file BKE_geometry_set.hh.

The documentation for this class was generated from the following files:
Generated on for Blender by  doxygen 1.16.1