Blender: blender::bke::ReadAttribute Class Reference

Blender V2.93

#include <BKE_attribute_access.hh>

Inherited by blender::bke::ArrayReadAttribute< T >, blender::bke::ConstantReadAttribute, blender::bke::ConvertedReadAttribute, blender::bke::DerivedArrayReadAttribute< StructT, ElemT, GetFunc >, blender::bke::OwnedArrayReadAttribute< T >, and blender::bke::VertexWeightReadAttribute.

Public Member Functions
	ReadAttribute (AttributeDomain domain, const CPPType &cpp_type, const int64_t size)

AttributeDomain	domain () const

const CPPType &	cpp_type () const

CustomDataType	custom_data_type () const

int64_t	size () const

void	get (const int64_t index, void *r_value) const

template<typename T >
Span< T >	get_span () const

Protected Member Functions
virtual void	get_internal (const int64_t index, void *r_value) const =0

Protected Attributes
const AttributeDomain	domain_

const CPPType &	cpp_type_

const CustomDataType	custom_data_type_

const int64_t	size_

std::mutex	span_mutex_

void *	array_buffer_ = nullptr

bool	array_is_temporary_ = false

Attribute Accessor implementations
virtual	~ReadAttribute ()

fn::GSpan	get_span () const

virtual void	initialize_span () const

Detailed Description

This class offers an indirection for reading an attribute. This is useful for the following reasons:

Blender does not store all attributes the same way. The simplest case are custom data layers with primitive types. A bit more complex are mesh attributes like the position of vertices, which are embedded into the MVert struct. Even more complex to access are vertex weights.
Sometimes attributes are stored on one domain, but we want to access the attribute on a different domain. Therefore, we have to interpolate between the domains.

Definition at line 51 of file BKE_attribute_access.hh.

Constructor & Destructor Documentation

◆ ReadAttribute()

blender::bke::ReadAttribute::ReadAttribute	(	AttributeDomain	domain,
		const CPPType &	cpp_type,
		const int64_t	size
	)

inline

Definition at line 67 of file BKE_attribute_access.hh.

◆ ~ReadAttribute()

blender::bke::ReadAttribute::~ReadAttribute ( )

virtual

Definition at line 57 of file attribute_access.cc.

References array_buffer_, array_is_temporary_, cpp_type_, blender::fn::CPPType::destruct_n(), MEM_freeN, and size_.

Member Function Documentation

◆ cpp_type()

const CPPType& blender::bke::ReadAttribute::cpp_type ( ) const

inline

Definition at line 82 of file BKE_attribute_access.hh.

References cpp_type_.

Referenced by blender::bke::TypedReadAttribute< T >::TypedReadAttribute().

◆ custom_data_type()

CustomDataType blender::bke::ReadAttribute::custom_data_type ( ) const

inline

Definition at line 87 of file BKE_attribute_access.hh.

References custom_data_type_.

Referenced by blender::ed::spreadsheet::GeometryDataSource::get_column_values().

◆ domain()

AttributeDomain blender::bke::ReadAttribute::domain ( ) const

inline

Definition at line 77 of file BKE_attribute_access.hh.

References domain_.

Referenced by blender::ed::spreadsheet::GeometryDataSource::get_column_values().

◆ get()

void blender::bke::ReadAttribute::get	(	const int64_t	index,
		void *	r_value
	)		const

inline

Definition at line 97 of file BKE_attribute_access.hh.

References BLI_assert, get_internal(), and size_.

Referenced by blender::bke::TypedReadAttribute< T >::operator[]().

◆ get_internal()

virtual void blender::bke::ReadAttribute::get_internal	(	const int64_t	index,
		void *	r_value
	)		const

protectedpure virtual

Implemented in blender::bke::VertexWeightReadAttribute, blender::bke::DerivedArrayReadAttribute< StructT, ElemT, GetFunc >, blender::bke::OwnedArrayReadAttribute< T >, blender::bke::ArrayReadAttribute< T >, and blender::bke::ConvertedReadAttribute.

Referenced by get(), and initialize_span().

◆ get_span() [1/2]

fn::GSpan blender::bke::ReadAttribute::get_span ( ) const

Definition at line 65 of file attribute_access.cc.

References array_buffer_, cpp_type_, initialize_span(), size_, and span_mutex_.

Referenced by get_span(), and blender::bke::TypedReadAttribute< T >::get_span().

◆ get_span() [2/2]

template<typename T >

Span<T> blender::bke::ReadAttribute::get_span ( ) const

inline

Definition at line 106 of file BKE_attribute_access.hh.

References get_span(), T, and blender::fn::GSpan::typed().

◆ initialize_span()

void blender::bke::ReadAttribute::initialize_span ( ) const

protectedvirtual

Reimplemented in blender::bke::OwnedArrayReadAttribute< T >, blender::bke::ArrayReadAttribute< T >, and blender::bke::ConstantReadAttribute.

Definition at line 79 of file attribute_access.cc.

References blender::fn::CPPType::alignment(), array_buffer_, array_is_temporary_, cpp_type_, get_internal(), MEM_mallocN_aligned, POINTER_OFFSET, blender::fn::CPPType::size(), and size_.

Referenced by get_span().

◆ size()

int64_t blender::bke::ReadAttribute::size ( ) const

inline

Definition at line 92 of file BKE_attribute_access.hh.

References size_.

Referenced by blender::ed::spreadsheet::GeometryDataSource::get_column_values(), and blender::bke::TypedReadAttribute< T >::size().

Member Data Documentation

◆ array_buffer_

void* blender::bke::ReadAttribute::array_buffer_ = nullptr

mutableprotected

Definition at line 62 of file BKE_attribute_access.hh.

Referenced by get_span(), initialize_span(), blender::bke::ConstantReadAttribute::initialize_span(), blender::bke::ArrayReadAttribute< T >::initialize_span(), blender::bke::OwnedArrayReadAttribute< T >::initialize_span(), and ~ReadAttribute().

◆ array_is_temporary_

bool blender::bke::ReadAttribute::array_is_temporary_ = false

mutableprotected

Definition at line 64 of file BKE_attribute_access.hh.

Referenced by initialize_span(), blender::bke::ConstantReadAttribute::initialize_span(), blender::bke::ArrayReadAttribute< T >::initialize_span(), blender::bke::OwnedArrayReadAttribute< T >::initialize_span(), and ~ReadAttribute().

◆ cpp_type_

const CPPType& blender::bke::ReadAttribute::cpp_type_

protected

Definition at line 54 of file BKE_attribute_access.hh.

Referenced by cpp_type(), blender::bke::ConstantReadAttribute::get_internal(), get_span(), initialize_span(), blender::bke::ConstantReadAttribute::initialize_span(), blender::bke::ConstantReadAttribute::~ConstantReadAttribute(), and ~ReadAttribute().

◆ custom_data_type_

const CustomDataType blender::bke::ReadAttribute::custom_data_type_

protected

Definition at line 55 of file BKE_attribute_access.hh.

Referenced by custom_data_type().

◆ domain_

const AttributeDomain blender::bke::ReadAttribute::domain_

protected

Definition at line 53 of file BKE_attribute_access.hh.

Referenced by domain().

◆ size_

const int64_t blender::bke::ReadAttribute::size_

protected

Definition at line 56 of file BKE_attribute_access.hh.

Referenced by get(), get_span(), initialize_span(), blender::bke::ConstantReadAttribute::initialize_span(), size(), and ~ReadAttribute().

◆ span_mutex_

std::mutex blender::bke::ReadAttribute::span_mutex_

mutableprotected

Definition at line 59 of file BKE_attribute_access.hh.

Referenced by get_span().

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