Blender: BKE_attribute.h File Reference

Blender V2.93

Generic geometry attributes built on CustomData. More...

#include "BLI_sys_types.h"
#include "BKE_customdata.h"

Go to the source code of this file.

Typedefs
typedef enum AttributeDomain	AttributeDomain

Enumerations
enum	AttributeDomain { ATTR_DOMAIN_AUTO = -1 , ATTR_DOMAIN_POINT = 0 , ATTR_DOMAIN_EDGE = 1 , ATTR_DOMAIN_CORNER = 2 , ATTR_DOMAIN_FACE = 3 , ATTR_DOMAIN_CURVE = 4 , ATTR_DOMAIN_NUM }

Functions
bool	BKE_id_attributes_supported (struct ID *id)

struct CustomDataLayer *	BKE_id_attribute_new (struct ID id, const char name, const int type, const AttributeDomain domain, struct ReportList *reports)

bool	BKE_id_attribute_remove (struct ID id, struct CustomDataLayer layer, struct ReportList *reports)

AttributeDomain	BKE_id_attribute_domain (struct ID id, struct CustomDataLayer layer)

int	BKE_id_attribute_data_length (struct ID id, struct CustomDataLayer layer)

bool	BKE_id_attribute_required (struct ID id, struct CustomDataLayer layer)

bool	BKE_id_attribute_rename (struct ID id, struct CustomDataLayer layer, const char new_name, struct ReportList reports)

int	BKE_id_attributes_length (struct ID *id, const CustomDataMask mask)

struct CustomDataLayer *	BKE_id_attributes_active_get (struct ID *id)

void	BKE_id_attributes_active_set (struct ID id, struct CustomDataLayer layer)

int *	BKE_id_attributes_active_index_p (struct ID *id)

CustomData *	BKE_id_attributes_iterator_next_domain (struct ID id, struct CustomDataLayer layers)

Detailed Description

Generic geometry attributes built on CustomData.

Definition in file BKE_attribute.h.

Typedef Documentation

◆ AttributeDomain

typedef enum AttributeDomain AttributeDomain

Enumeration Type Documentation

◆ AttributeDomain

enum AttributeDomain

Enumerator
ATTR_DOMAIN_AUTO
ATTR_DOMAIN_POINT
ATTR_DOMAIN_EDGE
ATTR_DOMAIN_CORNER
ATTR_DOMAIN_FACE
ATTR_DOMAIN_CURVE
ATTR_DOMAIN_NUM

Definition at line 41 of file BKE_attribute.h.

Function Documentation

◆ BKE_id_attribute_data_length()

int BKE_id_attribute_data_length	(	struct ID *	id,
		struct CustomDataLayer *	layer
	)

Definition at line 209 of file attribute.c.

References ARRAY_HAS_ITEM, ATTR_DOMAIN_NUM, BLI_assert, DomainInfo::customdata, get_domains(), CustomData::layers, DomainInfo::length, and CustomData::totlayer.

Referenced by BKE_id_attribute_remove().

◆ BKE_id_attribute_domain()

AttributeDomain BKE_id_attribute_domain	(	struct ID *	id,
		struct CustomDataLayer *	layer
	)

Definition at line 193 of file attribute.c.

References ARRAY_HAS_ITEM, ATTR_DOMAIN_NUM, BLI_assert, DomainInfo::customdata, get_domains(), CustomData::layers, and CustomData::totlayer.

◆ BKE_id_attribute_new()

struct CustomDataLayer* BKE_id_attribute_new	(	struct ID *	id,
		const char *	name,
		const int	type,
		const AttributeDomain	domain,
		struct ReportList *	reports
	)

Definition at line 137 of file attribute.c.

References ATTR_DOMAIN_NUM, BKE_report(), CD_DEFAULT, DomainInfo::customdata, CustomData_add_layer_named(), CustomData_get_named_layer_index(), get_domains(), CustomData::layers, length(), NULL, RPT_ERROR, and type.

Referenced by geometry_attribute_add_exec().

◆ BKE_id_attribute_remove()

bool BKE_id_attribute_remove	(	struct ID *	id,
		struct CustomDataLayer *	layer,
		struct ReportList *	reports
	)

Definition at line 154 of file attribute.c.

References attribute_customdata_find(), BKE_id_attribute_data_length(), BKE_id_attribute_required(), BKE_report(), CustomData_free_layer(), CustomData_get_named_layer_index(), length(), CustomDataLayer::name, RPT_ERROR, and CustomDataLayer::type.

Referenced by geometry_attribute_remove_exec().

◆ BKE_id_attribute_rename()

bool BKE_id_attribute_rename	(	struct ID *	id,
		struct CustomDataLayer *	layer,
		const char *	new_name,
		struct ReportList *	reports
	)

Definition at line 116 of file attribute.c.

References attribute_customdata_find(), BKE_id_attribute_required(), BKE_report(), BLI_assert, BLI_strncpy_utf8(), CustomData_set_layer_unique_name(), CustomData::layers, CustomDataLayer::name, NULL, and RPT_ERROR.

◆ BKE_id_attribute_required()

bool BKE_id_attribute_required	(	struct ID *	id,
		struct CustomDataLayer *	layer
	)

Definition at line 225 of file attribute.c.

References BKE_hair_customdata_required(), BKE_pointcloud_customdata_required(), GS, id, ID_HA, ID_PT, and ID::name.

Referenced by BKE_id_attribute_remove(), and BKE_id_attribute_rename().

◆ BKE_id_attributes_active_get()

struct CustomDataLayer* BKE_id_attributes_active_get ( struct ID * id )

Definition at line 239 of file attribute.c.

References ATTR_DOMAIN_NUM, BKE_id_attributes_active_index_p(), BKE_id_attributes_length(), CD_MASK_PROP_ALL, CD_TYPE_AS_MASK, DomainInfo::customdata, get_domains(), CustomData::layers, NULL, CustomData::totlayer, and CustomDataLayer::type.

Referenced by geometry_attribute_remove_exec().

◆ BKE_id_attributes_active_index_p()

int* BKE_id_attributes_active_index_p ( struct ID * id )

Definition at line 293 of file attribute.c.

References GS, id, ID_HA, ID_ME, ID_PT, ID::name, and NULL.

Referenced by BKE_id_attributes_active_get(), and BKE_id_attributes_active_set().

◆ BKE_id_attributes_active_set()

void BKE_id_attributes_active_set	(	struct ID *	id,
		struct CustomDataLayer *	layer
	)

Definition at line 269 of file attribute.c.

References ATTR_DOMAIN_NUM, BKE_id_attributes_active_index_p(), CD_MASK_PROP_ALL, CD_TYPE_AS_MASK, DomainInfo::customdata, get_domains(), CustomData::layers, CustomData::totlayer, and CustomDataLayer::type.

Referenced by geometry_attribute_add_exec().

◆ BKE_id_attributes_iterator_next_domain()

CustomData* BKE_id_attributes_iterator_next_domain	(	struct ID *	id,
		struct CustomDataLayer *	layers
	)

Definition at line 310 of file attribute.c.

References ATTR_DOMAIN_NUM, DomainInfo::customdata, get_domains(), CustomData::layers, and NULL.

◆ BKE_id_attributes_length()

int BKE_id_attributes_length	(	struct ID *	id,
		const CustomDataMask	mask
	)

Definition at line 176 of file attribute.c.

References ATTR_DOMAIN_NUM, DomainInfo::customdata, CustomData_number_of_layers_typemask(), get_domains(), length(), and mask().

Referenced by BKE_id_attributes_active_get().

◆ BKE_id_attributes_supported()

bool BKE_id_attributes_supported ( struct ID * id )

Definition at line 104 of file attribute.c.

References ATTR_DOMAIN_NUM, and get_domains().

Referenced by geometry_attributes_poll().