MeshComponent Class Reference

#include <BKE_geometry_set.hh>

Inherits GeometryComponent.

Public Member Functions
Geometry Component Implementation
	MeshComponent ()
	~MeshComponent ()
GeometryComponent *	copy () const override
void	clear ()
bool	has_mesh () const
void	replace (Mesh *mesh, GeometryOwnershipType ownership=GeometryOwnershipType::Owned)
void	replace_mesh_but_keep_vertex_group_names (Mesh *mesh, GeometryOwnershipType ownership=GeometryOwnershipType::Owned)
Mesh *	release ()
void	copy_vertex_group_names_from_object (const struct Object &object)
const blender::Map< std::string, int > &	vertex_group_names () const
blender::Map< std::string, int > &	vertex_group_names ()
const Mesh *	get_for_read () const
Mesh *	get_for_write ()
bool	is_empty () const final
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
bool	attribute_exists (const blender::StringRef attribute_name) const
bool	attribute_domain_supported (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)
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_MESH

Attribute Access
int	attribute_domain_size (const AttributeDomain domain) const final
blender::bke::ReadAttributePtr	attribute_try_adapt_domain (blender::bke::ReadAttributePtr attribute, const AttributeDomain new_domain) const final

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

Detailed Description

A geometry component that can store a mesh.

Definition at line 351 of file BKE_geometry_set.hh.

Constructor & Destructor Documentation

MeshComponent()

MeshComponent::MeshComponent

(

)

Definition at line 41 of file geometry_component_mesh.cc.

Referenced by copy().

~MeshComponent()

MeshComponent::~MeshComponent

(

)

Definition at line 45 of file geometry_component_mesh.cc.

References clear().

Member Function Documentation

attribute_domain_size()

int MeshComponent::attribute_domain_size ( const AttributeDomain  domain ) const

finalvirtual

Reimplemented from GeometryComponent.

Definition at line 180 of file geometry_component_mesh.cc.

References ATTR_DOMAIN_CORNER, ATTR_DOMAIN_EDGE, ATTR_DOMAIN_FACE, ATTR_DOMAIN_POINT, Mesh::totedge, Mesh::totloop, Mesh::totpoly, and Mesh::totvert.

attribute_try_adapt_domain()

ReadAttributePtr MeshComponent::attribute_try_adapt_domain ( blender::bke::ReadAttributePtr  attribute, const AttributeDomain  new_domain  ) const

finalvirtual

Reimplemented from GeometryComponent.

Definition at line 656 of file geometry_component_mesh.cc.

References blender::bke::adapt_mesh_domain_corner_to_edge(), blender::bke::adapt_mesh_domain_corner_to_face(), blender::bke::adapt_mesh_domain_corner_to_point(), blender::bke::adapt_mesh_domain_edge_to_corner(), blender::bke::adapt_mesh_domain_edge_to_face(), blender::bke::adapt_mesh_domain_edge_to_point(), blender::bke::adapt_mesh_domain_face_to_corner(), blender::bke::adapt_mesh_domain_face_to_edge(), blender::bke::adapt_mesh_domain_face_to_point(), blender::bke::adapt_mesh_domain_point_to_corner(), blender::bke::adapt_mesh_domain_point_to_edge(), blender::bke::adapt_mesh_domain_point_to_face(), ATTR_DOMAIN_CORNER, ATTR_DOMAIN_EDGE, ATTR_DOMAIN_FACE, and ATTR_DOMAIN_POINT.

clear()

void MeshComponent::clear

(

)

Definition at line 61 of file geometry_component_mesh.cc.

References BKE_id_free(), BLI_assert, blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::clear(), GeometryComponent::is_mutable(), and Owned.

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

copy()

GeometryComponent * MeshComponent::copy ( ) const

overridevirtual

Implements GeometryComponent.

Definition at line 50 of file geometry_component_mesh.cc.

References BKE_mesh_copy_for_eval(), MeshComponent(), and Owned.

copy_vertex_group_names_from_object()

void MeshComponent::copy_vertex_group_names_from_object

(

const struct Object &

object

)

Definition at line 114 of file geometry_component_mesh.cc.

References blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::add(), BLI_assert, blender::Map< Key, Value, InlineBufferCapacity, ProbingStrategy, Hash, IsEqual, Slot, Allocator >::clear(), GeometryComponent::is_mutable(), and LISTBASE_FOREACH.

Referenced by blender::bke::add_final_mesh_as_geometry_component(), editbmesh_calc_modifiers(), blender::ed::spreadsheet::get_display_geometry_set(), and mesh_calc_modifiers().

ensure_owns_direct_data()

void MeshComponent::ensure_owns_direct_data ( )

overridevirtual

Implements GeometryComponent.

Definition at line 165 of file geometry_component_mesh.cc.

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

get_for_read()

const Mesh * MeshComponent::get_for_read

(

)

const

Definition at line 138 of file geometry_component_mesh.cc.

Referenced by get_mesh_from_component_for_read(), blender::nodes::interpolate_existing_attributes(), blender::bke::NormalAttributeProvider::try_get_for_read(), and blender::bke::VertexGroupsAttributeProvider::try_get_for_read().

get_for_write()

Mesh * MeshComponent::get_for_write

(

)

Definition at line 145 of file geometry_component_mesh.cc.

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

Referenced by get_mesh_from_component_for_write(), blender::bke::VertexGroupsAttributeProvider::try_delete(), and blender::bke::VertexGroupsAttributeProvider::try_get_for_write().

has_mesh()

bool MeshComponent::has_mesh

(

)

const

Definition at line 73 of file geometry_component_mesh.cc.

is_empty()

bool MeshComponent::is_empty ( ) const

finalvirtual

Reimplemented from GeometryComponent.

Definition at line 155 of file geometry_component_mesh.cc.

owns_direct_data()

bool MeshComponent::owns_direct_data ( ) const

overridevirtual

Implements GeometryComponent.

Definition at line 160 of file geometry_component_mesh.cc.

References Owned.

release()

Mesh * MeshComponent::release

(

)

Definition at line 106 of file geometry_component_mesh.cc.

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

Referenced by modifier_modify_mesh_and_geometry_set(), and prepare_geometry_set_for_mesh_modifier().

replace()

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

Definition at line 79 of file geometry_component_mesh.cc.

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

Referenced by blender::bke::add_final_mesh_as_geometry_component(), blender::nodes::calculate_sphere_uvs(), blender::nodes::calculate_uvs(), blender::ed::spreadsheet::get_display_geometry_set(), blender::nodes::join_components(), and blender::bke::join_instance_groups_mesh().

replace_mesh_but_keep_vertex_group_names()

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

Definition at line 90 of file geometry_component_mesh.cc.

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

Referenced by blender::nodes::geo_node_subdivide_exec(), blender::nodes::geo_node_subdivision_surface_exec(), mesh_build_data(), modifier_modify_mesh_and_geometry_set(), and prepare_geometry_set_for_mesh_modifier().

vertex_group_names() [1/2]

blender::Map< std::string, int > & MeshComponent::vertex_group_names

(

)

Definition at line 131 of file geometry_component_mesh.cc.

vertex_group_names() [2/2]

const blender::Map< std::string, int > & MeshComponent::vertex_group_names

(

)

const

Definition at line 125 of file geometry_component_mesh.cc.

Referenced by blender::bke::VertexGroupsAttributeProvider::foreach_attribute(), blender::bke::VertexGroupsAttributeProvider::try_delete(), blender::bke::VertexGroupsAttributeProvider::try_get_for_read(), and blender::bke::VertexGroupsAttributeProvider::try_get_for_write().

Member Data Documentation

static_type

constexpr GeometryComponentType MeshComponent::static_type = GEO_COMPONENT_TYPE_MESH

inlinestaticconstexpr

Definition at line 388 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