Generic geometry attributes built on CustomData. More...

#include <string>
#include "BLI_string_ref.hh"
#include "BLI_sys_types.h"
#include "DNA_customdata_types.h"

Classes
class	AttributeOwner

Namespaces
namespace	blender

namespace	blender::bke

Macros
#define	ATTR_DOMAIN_AS_MASK(domain) ((AttrDomainMask)((1 << (int)(domain))))

#define	ATTR_DOMAIN_MASK_COLOR ((AttrDomainMask)((ATTR_DOMAIN_MASK_POINT \| ATTR_DOMAIN_MASK_CORNER)))

Typedefs
typedef enum AttrDomainMask	AttrDomainMask

Enumerations
enum	AttrDomainMask { ATTR_DOMAIN_MASK_POINT = (1 << 0) , ATTR_DOMAIN_MASK_EDGE = (1 << 1) , ATTR_DOMAIN_MASK_FACE = (1 << 2) , ATTR_DOMAIN_MASK_CORNER = (1 << 3) , ATTR_DOMAIN_MASK_CURVE = (1 << 4) , ATTR_DOMAIN_MASK_GREASE_PENCIL_LAYER = (1 << 6) , ATTR_DOMAIN_MASK_ALL = (1 << 7) - 1 }

enum class	AttributeOwnerType { Mesh , PointCloud , Curves , GreasePencil , GreasePencilDrawing }

Functions
	ENUM_OPERATORS (AttrDomainMask, ATTR_DOMAIN_MASK_ALL)

struct CustomDataLayer *	BKE_attribute_new (AttributeOwner &owner, const char name, eCustomDataType type, blender::bke::AttrDomain domain, struct ReportList reports)

bool	BKE_attribute_remove (AttributeOwner &owner, const char name, struct ReportList reports)

struct CustomDataLayer *	BKE_attribute_duplicate (AttributeOwner &owner, const char name, struct ReportList reports)

struct CustomDataLayer *	BKE_attribute_find (const AttributeOwner &owner, const char *name, eCustomDataType type, blender::bke::AttrDomain domain)

const struct CustomDataLayer *	BKE_attribute_search (const AttributeOwner &owner, const char *name, eCustomDataMask type, AttrDomainMask domain_mask)

struct CustomDataLayer *	BKE_attribute_search_for_write (AttributeOwner &owner, const char *name, eCustomDataMask type, AttrDomainMask domain_mask)

blender::bke::AttrDomain	BKE_attribute_domain (const AttributeOwner &owner, const struct CustomDataLayer *layer)

int	BKE_attribute_domain_size (const AttributeOwner &owner, int domain)

int	BKE_attribute_data_length (AttributeOwner &owner, struct CustomDataLayer *layer)

bool	BKE_attribute_required (const AttributeOwner &owner, const char *name)

bool	BKE_attribute_rename (AttributeOwner &owner, const char old_name, const char new_name, struct ReportList *reports)

int	BKE_attributes_length (const AttributeOwner &owner, AttrDomainMask domain_mask, eCustomDataMask mask)

struct CustomDataLayer *	BKE_attributes_active_get (AttributeOwner &owner)

void	BKE_attributes_active_set (AttributeOwner &owner, const char *name)

void	BKE_attributes_active_clear (AttributeOwner &owner)

int *	BKE_attributes_active_index_p (AttributeOwner &owner)

CustomData *	BKE_attributes_iterator_next_domain (AttributeOwner &owner, struct CustomDataLayer *layers)

CustomDataLayer *	BKE_attribute_from_index (AttributeOwner &owner, int lookup_index, AttrDomainMask domain_mask, eCustomDataMask layer_mask)

int	BKE_attribute_to_index (const AttributeOwner &owner, const CustomDataLayer *layer, AttrDomainMask domain_mask, eCustomDataMask layer_mask)

const char *	BKE_id_attributes_active_color_name (const struct ID *id)

const char *	BKE_id_attributes_default_color_name (const struct ID *id)

void	BKE_id_attributes_active_color_set (struct ID id, const char name)

void	BKE_id_attributes_active_color_clear (struct ID *id)

void	BKE_id_attributes_default_color_set (struct ID id, const char name)

const struct CustomDataLayer *	BKE_id_attributes_color_find (const struct ID id, const char name)

bool	BKE_color_attribute_supported (const struct Mesh &mesh, const blender::StringRef name)

std::string	BKE_attribute_calc_unique_name (const AttributeOwner &owner, const blender::StringRef name)

const char *	BKE_uv_map_vert_select_name_get (const char uv_map_name, char buffer)

const char *	BKE_uv_map_edge_select_name_get (const char uv_map_name, char buffer)

const char *	BKE_uv_map_pin_name_get (const char uv_map_name, char buffer)

Detailed Description

Generic geometry attributes built on CustomData.

Definition in file BKE_attribute.h.

Macro Definition Documentation

◆ ATTR_DOMAIN_AS_MASK

#define ATTR_DOMAIN_AS_MASK ( domain ) ((AttrDomainMask)((1 << (int)(domain))))

Definition at line 72 of file BKE_attribute.h.

Referenced by blender::ed::sculpt_paint::color::active_color_attribute(), blender::ed::sculpt_paint::color::active_color_attribute_for_write(), BKE_attribute_search(), BKE_color_attribute_supported(), blender::ed::geometry::geometry_color_attribute_convert_poll(), blender::bke::mesh_ensure_default_color_attribute_on_add(), blender::ed::object::meta_data_matches(), blender::bke::retrieve_attributes_for_transfer(), and blender::ed::sculpt_paint::undo::save_active_attribute().

◆ ATTR_DOMAIN_MASK_COLOR

#define ATTR_DOMAIN_MASK_COLOR ((AttrDomainMask)((ATTR_DOMAIN_MASK_POINT | ATTR_DOMAIN_MASK_CORNER)))

Definition at line 75 of file BKE_attribute.h.

Referenced by blender::ed::sculpt_paint::color::active_color_attribute(), blender::ed::sculpt_paint::color::active_color_attribute_for_write(), BKE_color_attribute_supported(), BKE_id_attributes_color_find(), color_clamp_index(), color_name_from_index(), color_name_to_index(), data_transfer_mesh_attributes_transfer_active_color_string(), data_transfer_mesh_attributes_transfer_default_color_string(), blender::ed::geometry::geometry_color_attribute_convert_poll(), blender::bke::mesh_ensure_default_color_attribute_on_add(), blender::ed::object::remove_invalid_attribute_strings(), and blender::ed::sculpt_paint::undo::save_active_attribute().

Typedef Documentation

◆ AttrDomainMask

typedef enum AttrDomainMask AttrDomainMask

Enumeration Type Documentation

◆ AttrDomainMask

enum AttrDomainMask

Enumerator
ATTR_DOMAIN_MASK_POINT
ATTR_DOMAIN_MASK_EDGE
ATTR_DOMAIN_MASK_FACE
ATTR_DOMAIN_MASK_CORNER
ATTR_DOMAIN_MASK_CURVE
ATTR_DOMAIN_MASK_GREASE_PENCIL_LAYER
ATTR_DOMAIN_MASK_ALL

Definition at line 33 of file BKE_attribute.h.

◆ AttributeOwnerType

enum class AttributeOwnerType

strong

Enumerator
Mesh
PointCloud
Curves
GreasePencil
GreasePencilDrawing

Definition at line 44 of file BKE_attribute.h.

Function Documentation

◆ BKE_attribute_calc_unique_name()

std::string BKE_attribute_calc_unique_name	(	const AttributeOwner &	owner,
		const blender::StringRef	name )

Definition at line 359 of file attribute.cc.

References attribute_name_exists(), BLI_uniquename_cb(), and DATA_.

Referenced by BKE_attribute_duplicate(), BKE_attribute_new(), BKE_attribute_rename(), BKE_sculpt_color_layer_create_if_needed(), ED_mesh_color_ensure(), ED_mesh_uv_add(), ensure_weight_attribute_meta_data(), and get_uv_attribute().

◆ BKE_attribute_data_length()

int BKE_attribute_data_length	(	AttributeOwner &	owner,
		struct CustomDataLayer *	layer )

Definition at line 736 of file attribute.cc.

References ATTR_DOMAIN_NUM, BLI_assert_msg, blender::Span< T >::contains_ptr(), get_domains(), AttributeOwner::get_mesh(), CustomData::layers, Mesh, CustomData::totlayer, and AttributeOwner::type().

◆ BKE_attribute_domain()

blender::bke::AttrDomain BKE_attribute_domain	(	const AttributeOwner &	owner,
		const struct CustomDataLayer *	layer )

Referenced by blender::ed::object::bake_targets_output_vertex_colors(), edbm_select_by_attribute_exec(), edbm_select_by_attribute_poll(), blender::ed::sculpt_paint::fill_mesh_color(), blender::ed::mesh::set_attribute::mesh_set_attribute_exec(), and blender::ed::mesh::set_attribute::mesh_set_attribute_invoke().

◆ BKE_attribute_domain_size()

int BKE_attribute_domain_size	(	const AttributeOwner &	owner,
		int	domain )

Definition at line 730 of file attribute.cc.

References get_domains().

◆ BKE_attribute_duplicate()

struct CustomDataLayer * BKE_attribute_duplicate	(	AttributeOwner &	owner,
		const char *	name,
		struct ReportList *	reports )

Creates a duplicate attribute layer.

Definition at line 432 of file attribute.cc.

References ATTR_DOMAIN_MASK_ALL, BKE_attribute_calc_unique_name(), bke_attribute_copy_if_exists(), BKE_attribute_search_for_write(), BKE_report(), BKE_uv_map_edge_select_name_get(), BKE_uv_map_pin_name_get(), BKE_uv_map_vert_select_name_get(), BLI_assert_unreachable, CD_MASK_PROP_ALL, CD_PROP_FLOAT2, blender::bke::GAttributeReader::domain, AttributeOwner::get_mesh(), MAX_CUSTOMDATA_LAYER_NAME, Mesh, RPT_ERROR, AttributeOwner::type(), blender::GVArrayCommon::type(), and blender::bke::GAttributeReader::varray.

Referenced by blender::ed::geometry::geometry_color_attribute_duplicate_exec().

◆ BKE_attribute_find()

struct CustomDataLayer * BKE_attribute_find	(	const AttributeOwner &	owner,
		const char *	name,
		eCustomDataType	type,
		blender::bke::AttrDomain	domain )

Referenced by blender::ed::sculpt_paint::undo::set_active_layer().

◆ BKE_attribute_from_index()

CustomDataLayer * BKE_attribute_from_index	(	AttributeOwner &	owner,
		int	lookup_index,
		AttrDomainMask	domain_mask,
		eCustomDataMask	layer_mask )

Definition at line 878 of file attribute.cc.

References ATTR_DOMAIN_NUM, CD_FLAG_TEMPORARY, CD_TYPE_AS_MASK, CustomDataLayer::flag, get_domains(), CustomData::layers, CustomData::totlayer, and CustomDataLayer::type.

Referenced by bmo_get_loop_color_ref(), color_name_from_index(), data_transfer_mesh_attributes_transfer_active_color_string(), and data_transfer_mesh_attributes_transfer_default_color_string().

◆ BKE_attribute_new()

struct CustomDataLayer * BKE_attribute_new	(	AttributeOwner &	owner,
		const char *	name,
		eCustomDataType	type,
		blender::bke::AttrDomain	domain,
		struct ReportList *	reports )

Create a new attribute layer.

Referenced by ED_mesh_color_add(), blender::ed::geometry::geometry_attribute_add_exec(), blender::ed::geometry::geometry_color_attribute_add_exec(), proj_paint_color_attribute_create(), and blender::io::alembic::read_velocity().

◆ BKE_attribute_remove()

bool BKE_attribute_remove	(	AttributeOwner &	owner,
		const char *	name,
		struct ReportList *	reports )

◆ BKE_attribute_rename()

bool BKE_attribute_rename	(	AttributeOwner &	owner,
		const char *	old_name,
		const char *	new_name,
		struct ReportList *	reports )

◆ BKE_attribute_required()

bool BKE_attribute_required	(	const AttributeOwner &	owner,
		const char *	name )

Definition at line 764 of file attribute.cc.

References BKE_curves_attribute_required(), BKE_grease_pencil_drawing_attribute_required(), BKE_mesh_attribute_required(), BKE_pointcloud_attribute_required(), Curves, AttributeOwner::get_curves(), AttributeOwner::get_grease_pencil_drawing(), AttributeOwner::get_pointcloud(), GreasePencil, GreasePencilDrawing, Mesh, PointCloud, and AttributeOwner::type().

Referenced by BKE_attribute_remove(), and BKE_attribute_rename().

◆ BKE_attribute_search()

const struct CustomDataLayer * BKE_attribute_search	(	const AttributeOwner &	owner,
		const char *	name,
		eCustomDataMask	type,
		AttrDomainMask	domain_mask )

Definition at line 636 of file attribute.cc.

References ATTR_DOMAIN_AS_MASK, ATTR_DOMAIN_NUM, CD_TYPE_AS_MASK, get_domains(), int, CustomData::layers, STREQ, and CustomData::totlayer.

Referenced by BKE_attribute_search_for_write(), BKE_attributes_active_set(), BKE_id_attributes_color_find(), color_name_to_index(), data_transfer_mesh_attributes_transfer_active_color_string(), data_transfer_mesh_attributes_transfer_default_color_string(), edbm_reverse_colors_exec(), and edbm_rotate_colors_exec().

◆ BKE_attribute_search_for_write()

struct CustomDataLayer * BKE_attribute_search_for_write	(	AttributeOwner &	owner,
		const char *	name,
		eCustomDataMask	type,
		AttrDomainMask	domain_mask )