VolumeComponent Class Reference

#include <BKE_geometry_set.hh>

Inherits GeometryComponent.

Public Member Functions
Geometry Component Implementation
	VolumeComponent ()
	~VolumeComponent ()
GeometryComponent *	copy () const override
void	clear ()
bool	has_volume () const
void	replace (Volume *volume, GeometryOwnershipType ownership=GeometryOwnershipType::Owned)
Volume *	release ()
const Volume *	get_for_read () const
Volume *	get_for_write ()
bool	owns_direct_data () const override
void	ensure_owns_direct_data () override
Public Member Functions inherited from GeometryComponent
virtual	~GeometryComponent ()=default
template<typename T >
blender::bke::TypedReadAttribute< T >	attribute_get_for_read (const blender::StringRef attribute_name, const AttributeDomain domain, const T &default_value) const
template<typename T >
blender::bke::TypedReadAttribute< T >	attribute_get_constant_for_read (const AttributeDomain domain, const T &value) const
	GeometryComponent (GeometryComponentType type)
void	user_add () const
void	user_remove () const
bool	is_mutable () const
GeometryComponentType	type () const
virtual bool	is_empty () const
bool	attribute_exists (const blender::StringRef attribute_name) const
bool	attribute_domain_supported (const AttributeDomain domain) const
virtual int	attribute_domain_size (const AttributeDomain domain) const
blender::bke::ReadAttributePtr	attribute_try_get_for_read (const blender::StringRef attribute_name) const
blender::bke::WriteAttributePtr	attribute_try_get_for_write (const blender::StringRef attribute_name)
virtual blender::bke::ReadAttributePtr	attribute_try_adapt_domain (blender::bke::ReadAttributePtr attribute, const AttributeDomain new_domain) const
bool	attribute_try_delete (const blender::StringRef attribute_name)
bool	attribute_try_create (const blender::StringRef attribute_name, const AttributeDomain domain, const CustomDataType data_type)
blender::Set< std::string >	attribute_names () const
bool	attribute_foreach (const AttributeForeachCallback callback) const
blender::bke::ReadAttributePtr	attribute_try_get_for_read (const blender::StringRef attribute_name, const AttributeDomain domain, const CustomDataType data_type) const
blender::bke::ReadAttributePtr	attribute_try_get_for_read (const blender::StringRef attribute_name, const AttributeDomain domain) const
blender::bke::ReadAttributePtr	attribute_get_for_read (const blender::StringRef attribute_name, const AttributeDomain domain, const CustomDataType data_type, const void *default_value) const
blender::bke::ReadAttributePtr	attribute_get_constant_for_read (const AttributeDomain domain, const CustomDataType data_type, const void *value) const
blender::bke::ReadAttributePtr	attribute_get_constant_for_read_converted (const AttributeDomain domain, const CustomDataType in_data_type, const CustomDataType out_data_type, const void *value) const
OutputAttributePtr	attribute_try_get_for_output (const blender::StringRef attribute_name, const AttributeDomain domain, const CustomDataType data_type, const void *default_value=nullptr)

Static Public Attributes
static constexpr GeometryComponentType	static_type = GEO_COMPONENT_TYPE_VOLUME

Additional Inherited Members
Static Public Member Functions inherited from GeometryComponent
static GeometryComponent *	create (GeometryComponentType component_type)

Detailed Description

A geometry component that stores volume grids.

Definition at line 468 of file BKE_geometry_set.hh.

Constructor & Destructor Documentation

VolumeComponent()

VolumeComponent::VolumeComponent

(

)

Definition at line 27 of file geometry_component_volume.cc.

Referenced by copy().

~VolumeComponent()

VolumeComponent::~VolumeComponent

(

)

Definition at line 31 of file geometry_component_volume.cc.

References clear().

Member Function Documentation

clear()

void VolumeComponent::clear

(

)

Definition at line 46 of file geometry_component_volume.cc.

References BKE_id_free(), BLI_assert, GeometryComponent::is_mutable(), and Owned.

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

copy()

GeometryComponent * VolumeComponent::copy ( ) const

overridevirtual

Implements GeometryComponent.

Definition at line 36 of file geometry_component_volume.cc.

References BKE_volume_copy_for_eval(), Owned, and VolumeComponent().

ensure_owns_direct_data()

void VolumeComponent::ensure_owns_direct_data ( )

overridevirtual

Implements GeometryComponent.

Definition at line 105 of file geometry_component_volume.cc.

References BKE_volume_copy_for_eval(), BLI_assert, GeometryComponent::is_mutable(), and Owned.

get_for_read()

const Volume * VolumeComponent::get_for_read

(

)

const

Definition at line 83 of file geometry_component_volume.cc.

Referenced by blender::nodes::compute_min_max_from_volume_and_transforms().

get_for_write()

Volume * VolumeComponent::get_for_write

(

)

Definition at line 90 of file geometry_component_volume.cc.

References BKE_volume_copy_for_eval(), BLI_assert, GeometryComponent::is_mutable(), Owned, and ReadOnly.

has_volume()

bool VolumeComponent::has_volume

(

)

const

Definition at line 57 of file geometry_component_volume.cc.

owns_direct_data()

bool VolumeComponent::owns_direct_data ( ) const

overridevirtual

Implements GeometryComponent.

Definition at line 100 of file geometry_component_volume.cc.

References Owned.

release()

Volume * VolumeComponent::release

(

)

Definition at line 73 of file geometry_component_volume.cc.

References BLI_assert, and GeometryComponent::is_mutable().

replace()

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

Definition at line 63 of file geometry_component_volume.cc.

References BLI_assert, clear(), and GeometryComponent::is_mutable().

Member Data Documentation

static_type

constexpr GeometryComponentType VolumeComponent::static_type = GEO_COMPONENT_TYPE_VOLUME

inlinestaticconstexpr

Definition at line 489 of file BKE_geometry_set.hh.

---

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

• BKE_geometry_set.hh
• geometry_component_volume.cc