openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType > Class Template Reference

#include <AttributeArray.h>

Inheritance diagram for openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >:

Public Types
using	Handle = AttributeHandle< ValueType, CodecType >
using	Ptr = std::shared_ptr< Handle >
using	UniquePtr = std::unique_ptr< Handle >

Public Member Functions
	AttributeHandle (const AttributeArray &array, const bool collapseOnDestruction=true)
	AttributeHandle (const AttributeHandle &)=default
AttributeHandle &	operator= (const AttributeHandle &)=default
virtual	~AttributeHandle ()
Index	stride () const
Index	size () const
bool	isUniform () const
bool	hasConstantStride () const
ValueType	get (Index n, Index m=0) const
const AttributeArray &	array () const

Static Public Member Functions
static Ptr	create (const AttributeArray &array, const bool collapseOnDestruction=true)

Protected Types
using	GetterPtr = ValueType(*)(const AttributeArray *array, const Index n)
using	SetterPtr = void(*)(AttributeArray *array, const Index n, const ValueType &value)
using	ValuePtr = void(*)(AttributeArray *array, const ValueType &value)

Protected Member Functions
Index	index (Index n, Index m) const

Protected Attributes
const AttributeArray *	mArray
GetterPtr	mGetter
SetterPtr	mSetter
ValuePtr	mCollapser
ValuePtr	mFiller

Friends
class	::TestAttributeArray

Detailed Description

template<typename ValueType, typename CodecType = UnknownCodec>
class openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >

AttributeHandles provide access to specific TypedAttributeArray methods without needing to know the compression codec, however these methods also incur the cost of a function pointer

Definition at line 763 of file AttributeArray.h.

Member Typedef Documentation

template<typename ValueType, typename CodecType = UnknownCodec>

using openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::GetterPtr = ValueType (*)(const AttributeArray* array, const Index n)

protected

Definition at line 771 of file AttributeArray.h.

template<typename ValueType, typename CodecType = UnknownCodec>

using openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::Handle = AttributeHandle<ValueType, CodecType>

Definition at line 766 of file AttributeArray.h.

template<typename ValueType, typename CodecType = UnknownCodec>

using openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::Ptr = std::shared_ptr<Handle>

Definition at line 767 of file AttributeArray.h.

template<typename ValueType, typename CodecType = UnknownCodec>

using openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::SetterPtr = void (*)(AttributeArray* array, const Index n, const ValueType& value)

protected

Definition at line 772 of file AttributeArray.h.

template<typename ValueType, typename CodecType = UnknownCodec>

using openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::UniquePtr = std::unique_ptr<Handle>

Definition at line 768 of file AttributeArray.h.

template<typename ValueType, typename CodecType = UnknownCodec>

using openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::ValuePtr = void (*)(AttributeArray* array, const ValueType& value)

protected

Definition at line 773 of file AttributeArray.h.

Constructor & Destructor Documentation

template<typename ValueType , typename CodecType >

openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::AttributeHandle	(	const AttributeArray &	array,
		const bool	collapseOnDestruction = true
	)

Definition at line 1991 of file AttributeArray.h.

template<typename ValueType, typename CodecType = UnknownCodec>

openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::AttributeHandle ( const AttributeHandle< ValueType, CodecType > &  )

default

template<typename ValueType , typename CodecType >

openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::~AttributeHandle ( )

virtual

Definition at line 2019 of file AttributeArray.h.

Member Function Documentation

template<typename ValueType , typename CodecType >

const AttributeArray & openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::array

(

)

const

Definition at line 2046 of file AttributeArray.h.

template<typename ValueType , typename CodecType >

AttributeHandle< ValueType, CodecType >::Ptr openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::create ( const AttributeArray &  array, const bool  collapseOnDestruction = true  )

static

Definition at line 1984 of file AttributeArray.h.

template<typename ValueType , typename CodecType >

ValueType openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::get	(	Index	n,
		Index	m = 0
	)		const

Definition at line 2061 of file AttributeArray.h.

template<typename ValueType , typename CodecType >

bool openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::hasConstantStride

(

)

const

Definition at line 2093 of file AttributeArray.h.

template<typename ValueType , typename CodecType >

Index openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::index ( Index  n, Index  m  ) const

protected

Definition at line 2053 of file AttributeArray.h.

template<typename ValueType , typename CodecType >

bool openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::isUniform

(

)

const

Definition at line 2087 of file AttributeArray.h.

template<typename ValueType, typename CodecType = UnknownCodec>

AttributeHandle& openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::operator= ( const AttributeHandle< ValueType, CodecType > &  )

default

template<typename ValueType, typename CodecType = UnknownCodec>

Index openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::size ( void  ) const

inline

Definition at line 786 of file AttributeArray.h.

template<typename ValueType, typename CodecType = UnknownCodec>

Index openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::stride ( ) const

inline

Definition at line 785 of file AttributeArray.h.

Friends And Related Function Documentation

template<typename ValueType, typename CodecType = UnknownCodec>

friend class ::TestAttributeArray

friend

Definition at line 806 of file AttributeArray.h.

Member Data Documentation

template<typename ValueType, typename CodecType = UnknownCodec>

const AttributeArray* openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::mArray

protected

Definition at line 798 of file AttributeArray.h.

template<typename ValueType, typename CodecType = UnknownCodec>

ValuePtr openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::mCollapser

protected

Definition at line 802 of file AttributeArray.h.

template<typename ValueType, typename CodecType = UnknownCodec>

ValuePtr openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::mFiller

protected

Definition at line 803 of file AttributeArray.h.

template<typename ValueType, typename CodecType = UnknownCodec>

GetterPtr openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::mGetter

protected

Definition at line 800 of file AttributeArray.h.

template<typename ValueType, typename CodecType = UnknownCodec>

SetterPtr openvdb::OPENVDB_VERSION_NAME::points::AttributeHandle< ValueType, CodecType >::mSetter

protected

Definition at line 801 of file AttributeArray.h.

---

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

• openvdb/points/AttributeArray.h