blender::nodes::MeshComponent Class Reference

#include <BKE_geometry_set.hh>

Inherits blender::bke::GeometryComponent.

Public Member Functions
Geometry Component Implementation
	MeshComponent ()
	MeshComponent (Mesh *mesh, GeometryOwnershipType ownership=GeometryOwnershipType::Owned)
	~MeshComponent () override
GeometryComponentPtr	copy () const override
void	clear () override
bool	has_mesh () const
void	replace (Mesh *mesh, GeometryOwnershipType ownership=GeometryOwnershipType::Owned)
Mesh *	release ()
const Mesh *	get () const
Mesh *	get_for_write ()
bool	is_empty () const final
bool	owns_direct_data () const override
void	ensure_owns_direct_data () override
void	count_memory (MemoryCounter &memory) const override
Attribute Access
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::Mesh

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 can store a mesh, using the Mesh data-block. Attributes are stored on any of the four attribute domains.

Definition at line 476 of file BKE_geometry_set.hh.

Constructor & Destructor Documentation

MeshComponent() [1/2]

blender::bke::MeshComponent::MeshComponent

(

)

Definition at line 20 of file geometry_component_mesh.cc.

MeshComponent() [2/2]

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

Definition at line 22 of file geometry_component_mesh.cc.

~MeshComponent()

blender::bke::MeshComponent::~MeshComponent ( )

override

Definition at line 27 of file geometry_component_mesh.cc.

Member Function Documentation

attributes()

std::optional< AttributeAccessor > blender::bke::MeshComponent::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 179 of file geometry_component_mesh.cc.

attributes_for_write()

std::optional< MutableAttributeAccessor > blender::bke::MeshComponent::attributes_for_write ( )

finalvirtual

Reimplemented from blender::bke::GeometryComponent.

Definition at line 184 of file geometry_component_mesh.cc.

clear()

void blender::bke::MeshComponent::clear ( )

overridevirtual

Remove referenced data from the geometry component.

Implements blender::bke::GeometryComponent.

Definition at line 42 of file geometry_component_mesh.cc.

copy()

GeometryComponentPtr blender::bke::MeshComponent::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 32 of file geometry_component_mesh.cc.

count_memory()

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

overridevirtual

Reimplemented from blender::bke::GeometryComponent.

Definition at line 110 of file geometry_component_mesh.cc.

ensure_owns_direct_data()

void blender::bke::MeshComponent::ensure_owns_direct_data ( )

overridevirtual

Implements blender::bke::GeometryComponent.

Definition at line 99 of file geometry_component_mesh.cc.

get()

const Mesh * blender::bke::MeshComponent::get

(

)

const

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

Definition at line 74 of file geometry_component_mesh.cc.

get_for_write()

Mesh * blender::bke::MeshComponent::get_for_write

(

)

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

Definition at line 79 of file geometry_component_mesh.cc.

has_mesh()

bool blender::bke::MeshComponent::has_mesh

(

)

const

Definition at line 53 of file geometry_component_mesh.cc.

is_empty()

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

finalvirtual

Reimplemented from blender::bke::GeometryComponent.

Definition at line 89 of file geometry_component_mesh.cc.

owns_direct_data()

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

overridevirtual

Implements blender::bke::GeometryComponent.

Definition at line 94 of file geometry_component_mesh.cc.

release()

Mesh * blender::bke::MeshComponent::release

(

)

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

Definition at line 66 of file geometry_component_mesh.cc.

replace()

void blender::bke::MeshComponent::replace	(	Mesh *	mesh,
		GeometryOwnershipType	ownership = GeometryOwnershipType::Owned )

Clear the component and replace it with the new mesh.

Definition at line 58 of file geometry_component_mesh.cc.

Member Data Documentation

static_type

GeometryComponent::Type blender::bke::MeshComponent::static_type = Type::Mesh

staticconstexpr

Definition at line 517 of file BKE_geometry_set.hh.

---

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

• BKE_geometry_set.hh
• geometry_component_mesh.cc