Blender: blender::bke::BuiltinAttributeProvider Class Reference

Blender V5.0

#include <attribute_access_intern.hh>

Inherited by blender::bke::BuiltinCustomDataLayerProvider.

Public Types
enum	DeletableEnum { Deletable , NonDeletable }

Public Member Functions
	BuiltinAttributeProvider (std::string name, const AttrDomain domain, const eCustomDataType data_type, const DeletableEnum deletable, AttributeValidator validator={}, const GPointer default_value={})
virtual GAttributeReader	try_get_for_read (const void *owner) const =0
virtual GAttributeWriter	try_get_for_write (void *owner) const =0
virtual bool	try_delete (void *owner) const =0
virtual bool	try_create (void *owner, const AttributeInit &initializer) const =0
virtual bool	exists (const void *owner) const =0
StringRefNull	name () const
AttrDomain	domain () const
eCustomDataType	data_type () const
AttributeValidator	validator () const
GPointer	default_value () const

Protected Attributes
const std::string	name_
const AttrDomain	domain_
const eCustomDataType	data_type_
const DeletableEnum	deletable_
const AttributeValidator	validator_
const GPointer	default_value_

Detailed Description

A BuiltinAttributeProvider is responsible for exactly one attribute on a geometry component. The attribute is identified by its name and has a fixed domain and type. Builtin attributes do not follow the same loose rules as other attributes, because they are mapped to internal "legacy" data structures. For example, some builtin attributes cannot be deleted.

Definition at line 41 of file attribute_access_intern.hh.

Member Enumeration Documentation

◆ DeletableEnum

enum blender::bke::BuiltinAttributeProvider::DeletableEnum

Enumerator
Deletable
NonDeletable

Definition at line 43 of file attribute_access_intern.hh.

Constructor & Destructor Documentation

◆ BuiltinAttributeProvider()

blender::bke::BuiltinAttributeProvider::BuiltinAttributeProvider	(	std::string	name,
		const AttrDomain	domain,
		const eCustomDataType	data_type,
		const DeletableEnum	deletable,
		AttributeValidator	validator = {},
		const GPointer	default_value = {} )

inline

Definition at line 57 of file attribute_access_intern.hh.

References data_type(), domain(), name(), and validator().

Member Function Documentation

◆ data_type()

eCustomDataType blender::bke::BuiltinAttributeProvider::data_type ( ) const

inline

Definition at line 88 of file attribute_access_intern.hh.

References data_type_.

Referenced by BuiltinAttributeProvider(), and blender::bke::BuiltinCustomDataLayerProvider::BuiltinCustomDataLayerProvider().

◆ default_value()

GPointer blender::bke::BuiltinAttributeProvider::default_value ( ) const

inline

Definition at line 98 of file attribute_access_intern.hh.

References default_value_.

◆ domain()

AttrDomain blender::bke::BuiltinAttributeProvider::domain ( ) const

inline

Definition at line 83 of file attribute_access_intern.hh.

References domain_.

Referenced by BuiltinAttributeProvider(), and blender::bke::BuiltinCustomDataLayerProvider::BuiltinCustomDataLayerProvider().

◆ exists()

virtual bool blender::bke::BuiltinAttributeProvider::exists ( const void * owner ) const

pure virtual

Implemented in blender::bke::BuiltinCustomDataLayerProvider.

◆ name()

StringRefNull blender::bke::BuiltinAttributeProvider::name ( ) const

inline

Definition at line 78 of file attribute_access_intern.hh.

References name_.

Referenced by BuiltinAttributeProvider().

◆ try_create()

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

pure virtual

Implemented in blender::bke::BuiltinCustomDataLayerProvider.

◆ try_delete()

virtual bool blender::bke::BuiltinAttributeProvider::try_delete ( void * owner ) const

pure virtual

Implemented in blender::bke::BuiltinCustomDataLayerProvider.

◆ try_get_for_read()

virtual GAttributeReader blender::bke::BuiltinAttributeProvider::try_get_for_read ( const void * owner ) const

pure virtual

Implemented in blender::bke::BuiltinCustomDataLayerProvider.

◆ try_get_for_write()

virtual GAttributeWriter blender::bke::BuiltinAttributeProvider::try_get_for_write ( void * owner ) const

pure virtual

Implemented in blender::bke::BuiltinCustomDataLayerProvider.

◆ validator()

AttributeValidator blender::bke::BuiltinAttributeProvider::validator ( ) const

inline

Definition at line 93 of file attribute_access_intern.hh.

References validator_.

Referenced by BuiltinAttributeProvider(), blender::bke::BuiltinCustomDataLayerProvider::BuiltinCustomDataLayerProvider(), and blender::bke::attribute_accessor_functions::lookup_validator().

Member Data Documentation

◆ data_type_

const eCustomDataType blender::bke::BuiltinAttributeProvider::data_type_

protected

Definition at line 51 of file attribute_access_intern.hh.

Referenced by data_type(), blender::bke::BuiltinCustomDataLayerProvider::exists(), blender::bke::BuiltinCustomDataLayerProvider::try_create(), blender::bke::BuiltinCustomDataLayerProvider::try_get_for_read(), and blender::bke::BuiltinCustomDataLayerProvider::try_get_for_write().

◆ default_value_

const GPointer blender::bke::BuiltinAttributeProvider::default_value_

protected

Definition at line 54 of file attribute_access_intern.hh.

Referenced by default_value(), and blender::bke::BuiltinCustomDataLayerProvider::try_create().

◆ deletable_

const DeletableEnum blender::bke::BuiltinAttributeProvider::deletable_

protected

Definition at line 52 of file attribute_access_intern.hh.

Referenced by blender::bke::BuiltinCustomDataLayerProvider::try_delete().

◆ domain_

const AttrDomain blender::bke::BuiltinAttributeProvider::domain_

protected

Definition at line 50 of file attribute_access_intern.hh.

Referenced by domain(), blender::bke::BuiltinCustomDataLayerProvider::try_get_for_read(), and blender::bke::BuiltinCustomDataLayerProvider::try_get_for_write().

◆ name_

const std::string blender::bke::BuiltinAttributeProvider::name_

protected

Definition at line 49 of file attribute_access_intern.hh.

Referenced by blender::bke::BuiltinCustomDataLayerProvider::exists(), name(), blender::bke::BuiltinCustomDataLayerProvider::try_create(), blender::bke::BuiltinCustomDataLayerProvider::try_delete(), blender::bke::BuiltinCustomDataLayerProvider::try_get_for_read(), and blender::bke::BuiltinCustomDataLayerProvider::try_get_for_write().

◆ validator_

const AttributeValidator blender::bke::BuiltinAttributeProvider::validator_

protected

Definition at line 53 of file attribute_access_intern.hh.

Referenced by validator().

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

attribute_access_intern.hh