Blender V5.0
blender::nodes::VolumeComponent Class Reference

#include <BKE_geometry_set.hh>

Inherits blender::bke::GeometryComponent.

Public Member Functions

Geometry Component Implementation
 VolumeComponent ()
 ~VolumeComponent () override
GeometryComponentPtr copy () const override
void clear () override
bool has_volume () const
void replace (Volume *volume, GeometryOwnershipType ownership=GeometryOwnershipType::Owned)
Volumerelease ()
const Volumeget () const
Volumeget_for_write ()
bool owns_direct_data () const override
void ensure_owns_direct_data () override
void count_memory (MemoryCounter &memory) const override
Public Member Functions inherited from blender::bke::GeometryComponent
 ~GeometryComponent () override=default
 GeometryComponent (Type type)
int attribute_domain_size (AttrDomain domain) const
virtual std::optional< AttributeAccessorattributes () const
virtual std::optional< MutableAttributeAccessorattributes_for_write ()
Type type () const
virtual bool is_empty () 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::Volume

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 volume grids, corresponding to the Volume data structure. This component does not implement an attribute API, partly because storage of sparse volume information in grids is much more complicated than it is for other types

Definition at line 681 of file BKE_geometry_set.hh.

Constructor & Destructor Documentation

◆ VolumeComponent()

◆ ~VolumeComponent()

Member Function Documentation

◆ clear()

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

Remove referenced data from the geometry component.

Implements blender::bke::GeometryComponent.

Definition at line 32 of file geometry_component_volume.cc.

◆ copy()

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

Implements blender::bke::GeometryComponent.

Definition at line 22 of file geometry_component_volume.cc.

◆ count_memory()

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

Reimplemented from blender::bke::GeometryComponent.

Definition at line 95 of file geometry_component_volume.cc.

◆ ensure_owns_direct_data()

◆ get()

Get the volume from this component. This method can be used by multiple threads at the same time. Therefore, the returned volume should not be modified. No ownership is transferred.

Definition at line 64 of file geometry_component_volume.cc.

◆ get_for_write()

Get the volume from this component. This method can only be used when the component is mutable, i.e. it is not shared. The returned volume can be modified. No ownership is transferred.

Definition at line 69 of file geometry_component_volume.cc.

◆ has_volume()

◆ owns_direct_data()

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

Implements blender::bke::GeometryComponent.

Definition at line 79 of file geometry_component_volume.cc.

◆ release()

Return the volume and clear the component. The caller takes over responsibility for freeing the volume (if the component was responsible before).

Definition at line 56 of file geometry_component_volume.cc.

◆ replace()

Clear the component and replace it with the new volume.

Definition at line 48 of file geometry_component_volume.cc.

Member Data Documentation

◆ static_type


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