Blender: blender::bke::BuiltinCustomDataLayerProvider Class Reference

Blender V4.5

#include <attribute_access_intern.hh>

Inherits blender::bke::BuiltinAttributeProvider.

Public Member Functions
	BuiltinCustomDataLayerProvider (std::string attribute_name, const AttrDomain domain, const eCustomDataType data_type, const DeletableEnum deletable, const CustomDataAccessInfo custom_data_access, const UpdateOnChange update_on_change, const AttributeValidator validator={}, const GPointer default_value={})
GAttributeReader	try_get_for_read (const void *owner) const final
GAttributeWriter	try_get_for_write (void *owner) const final
bool	try_delete (void *owner) const final
bool	try_create (void *owner, const AttributeInit &initializer) const final
bool	exists (const void *owner) const final
Public Member Functions inherited from blender::bke::BuiltinAttributeProvider
	BuiltinAttributeProvider (std::string name, const AttrDomain domain, const eCustomDataType data_type, const DeletableEnum deletable, AttributeValidator validator={}, const GPointer default_value={})
StringRefNull	name () const
AttrDomain	domain () const
eCustomDataType	data_type () const
AttributeValidator	validator () const
GPointer	default_value () const

Additional Inherited Members
Public Types inherited from blender::bke::BuiltinAttributeProvider
enum	DeletableEnum { Deletable , NonDeletable }
Protected Attributes inherited from blender::bke::BuiltinAttributeProvider
const std::string	name_
const AttrDomain	domain_
const eCustomDataType	data_type_
const DeletableEnum	deletable_
const AttributeValidator	validator_
const GPointer	default_value_

Detailed Description

This provider is used to provide access to builtin attributes. It supports making internal types available as different types.

It also supports named builtin attributes, and will look up attributes in CustomData by name if the stored type is the same as the attribute type.

Definition at line 181 of file attribute_access_intern.hh.

Constructor & Destructor Documentation

◆ BuiltinCustomDataLayerProvider()

blender::bke::BuiltinCustomDataLayerProvider::BuiltinCustomDataLayerProvider	(	std::string	attribute_name,
		const AttrDomain	domain,
		const eCustomDataType	data_type,
		const DeletableEnum	deletable,
		const CustomDataAccessInfo	custom_data_access,
		const UpdateOnChange	update_on_change,
		const AttributeValidator	validator = {},
		const GPointer	default_value = {} )

inline

Definition at line 187 of file attribute_access_intern.hh.

References blender::bke::BuiltinAttributeProvider::data_type(), blender::bke::BuiltinAttributeProvider::domain(), and blender::bke::BuiltinAttributeProvider::validator().

Member Function Documentation

◆ exists()

bool blender::bke::BuiltinCustomDataLayerProvider::exists ( const void * owner ) const

finalvirtual

Implements blender::bke::BuiltinAttributeProvider.

Definition at line 514 of file attribute_access.cc.

References CustomData_has_layer_named(), blender::bke::BuiltinAttributeProvider::data_type_, and blender::bke::BuiltinAttributeProvider::name_.

◆ try_create()

bool blender::bke::BuiltinCustomDataLayerProvider::try_create	(	void *	owner,
		const AttributeInit &	initializer ) const

finalvirtual

Implements blender::bke::BuiltinAttributeProvider.

Definition at line 485 of file attribute_access.cc.

References blender::bke::add_custom_data_layer_from_attribute_init(), blender::bke::AttributeInit::Construct, CustomData_has_layer_named(), blender::bke::BuiltinAttributeProvider::data_type_, blender::bke::BuiltinAttributeProvider::default_value_, blender::bke::BuiltinAttributeProvider::name_, and blender::bke::AttributeInit::type.

◆ try_delete()

bool blender::bke::BuiltinCustomDataLayerProvider::try_delete ( void * owner ) const

finalvirtual

Implements blender::bke::BuiltinAttributeProvider.

Definition at line 466 of file attribute_access.cc.

References CustomData_free_layer_named(), blender::bke::BuiltinAttributeProvider::Deletable, blender::bke::BuiltinAttributeProvider::deletable_, and blender::bke::BuiltinAttributeProvider::name_.

◆ try_get_for_read()

GAttributeReader blender::bke::BuiltinCustomDataLayerProvider::try_get_for_read ( const void * owner ) const

finalvirtual

Implements blender::bke::BuiltinAttributeProvider.

Definition at line 412 of file attribute_access.cc.

References blender::bke::custom_data_type_to_cpp_type(), CustomData_get_named_layer_index(), CustomDataLayer::data, blender::bke::BuiltinAttributeProvider::data_type_, blender::bke::BuiltinAttributeProvider::domain_, blender::GVArray::ForSpan(), CustomData::layers, blender::bke::BuiltinAttributeProvider::name_, and CustomDataLayer::sharing_info.

◆ try_get_for_write()

GAttributeWriter blender::bke::BuiltinCustomDataLayerProvider::try_get_for_write ( void * owner ) const

finalvirtual

Implements blender::bke::BuiltinAttributeProvider.

Definition at line 437 of file attribute_access.cc.

References blender::bke::custom_data_type_to_cpp_type(), CustomData_get_layer_named_for_write(), data, blender::bke::BuiltinAttributeProvider::data_type_, blender::bke::BuiltinAttributeProvider::domain_, blender::GVMutableArray::ForSpan(), blender::bke::BuiltinAttributeProvider::name_, and update().

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